Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new stylus-lang.com #2695

Merged
merged 7 commits into from
Sep 11, 2022
Merged

docs: new stylus-lang.com #2695

merged 7 commits into from
Sep 11, 2022

Conversation

iChenLei
Copy link
Member

@iChenLei iChenLei commented Jun 5, 2022

What:

Try to fix #1242 and fix stylus/stylus-lang.com#23

Why:

Modern documentation website is required !!!

How:

Using vitepress and netlify deploy our documentation website

Description ScreenShot
HomePage
HomePage(dark)
Algolia search
Syntax Hilght(before)
Syntax Hilght(after)
TOC Anchor
i18n
Display on mobile HomePage(old) HomePag(new) SubPage(new)
Compare

TODO List:

cc @corysimmons @futekov @groenroos @ota-meshi @ThisIsManta

@corysimmons
Copy link

I love this but I would keep the new logo.

@futekov
Copy link
Contributor

futekov commented Jun 5, 2022

Great work, lots of improvement.
I'm fine with both the new and the old logo.

@iChenLei
Copy link
Member Author

iChenLei commented Jun 5, 2022

Hi, All. Try https://stylus-docs.netlify.app , give me more feedback. Thanks

@netlify
Copy link

netlify bot commented Jun 5, 2022

Deploy Preview for stylus-docs ready!

Name Link
🔨 Latest commit b37485d
🔍 Latest deploy log https://app.netlify.com/sites/stylus-docs/deploys/631da8ebb9f3440009db06c0
😎 Deploy Preview https://deploy-preview-2695--stylus-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@groenroos
Copy link
Collaborator

The new site looks amazing, really good job on this! 🎉

The documentation navigation is a lot better - although I wonder if it could be improved even more by coming up with some sort of logical grouping of the different features (instead of one long flat list in no particular order), so it's easier to scan for what you need?

I also echo @corysimmons' sentiment, I think we should keep the newer logo.

I think we need to also tighten up some of the language on the front page - happy to help with this!

@ota-meshi
Copy link
Member

The new site is really cool! Thank you for great job!

@iChenLei
Copy link
Member Author

iChenLei commented Sep 1, 2022

@corysimmons Are you manage stylus-lang.com domain ? How can we use the new doc site ?

@corysimmons
Copy link

@iChenLei Sorry, no. I handed it off to @futekov a few years ago.

@iChenLei iChenLei marked this pull request as ready for review September 2, 2022 11:24
@iChenLei iChenLei changed the title WIP: docs: new stylus-lang.com docs: new stylus-lang.com Sep 11, 2022
@iChenLei iChenLei merged commit ae16898 into dev Sep 11, 2022
@iChenLei iChenLei deleted the docs-new branch September 11, 2022 09:41
@corysimmons
Copy link

@iChenLei Good job! New site looks great 👏

@nazarepiedady
Copy link

nazarepiedady commented Dec 5, 2022

@iChenLei, @corysimmons, @kizu, @ota-meshi, @Panya, @xdan, @pakastin

I am working on the translation to Portuguese of the website but I am having
some errors during the deployment to Netlify.

Could you give me some light on how to solve this?

Could you help me to fix those warnings? it bothers me a little to see them there.

Thanks.

4:11:14 AM: build-image version: 4c0c1cadee6a31c9bb8d824514030009c4c05c6a (focal)
4:11:14 AM: build-image tag: v4.15.0
4:11:14 AM: buildbot version: 9ef4dba9386902658d5cc7ad8ca0406443896076
4:11:15 AM: Fetching cached dependencies
4:11:15 AM: Failed to fetch cache, continuing with build
4:11:15 AM: Starting to prepare the repo for build
4:11:15 AM: No cached dependencies found. Cloning fresh repo
4:11:15 AM: git clone https://github.com/nazarepiedady/stylus-docs-pt
4:11:15 AM: Preparing Git Reference refs/heads/main
4:11:16 AM: Parsing package.json dependencies
4:11:17 AM: Different build dir detected, going to use the one specified in the Netlify configuration file: 'docs' versus 'docs/' in the Netlify UI
4:11:17 AM: Different publish path detected, going to use the one specified in the Netlify configuration file: 'docs/.vitepress/dist' versus '.vitepress/dist' in the Netlify UI
4:11:17 AM: Section completed: initializing
4:11:17 AM: Starting build script
4:11:17 AM: Installing dependencies
4:11:17 AM: Python version set to 2.7
4:11:17 AM: v16.18.1 is already installed.
4:11:18 AM: Now using node v16.18.1 (npm v8.19.2)
4:11:18 AM: Enabling node corepack
4:11:18 AM: Started restoring cached build plugins
4:11:18 AM: Finished restoring cached build plugins
4:11:18 AM: Attempting ruby version 2.7.2, read from environment
4:11:18 AM: Using ruby version 2.7.2
4:11:18 AM: Using PHP version 8.0
4:11:19 AM: No npm workspaces detected
4:11:19 AM: Started restoring cached node modules
4:11:19 AM: Finished restoring cached node modules
4:11:19 AM: Installing NPM modules using NPM version 8.19.2
4:11:41 AM: npm WARN deprecated [email protected]: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-terser
4:11:41 AM: npm WARN deprecated [email protected]: Please use @jridgewell/sourcemap-codec instead
4:11:43 AM: added 574 packages, and audited 575 packages in 24s
4:11:43 AM: 98 packages are looking for funding
4:11:43 AM:   run `npm fund` for details
4:11:43 AM: found 0 vulnerabilities
4:11:43 AM: NPM modules installed
4:11:43 AM: Creating package sha
4:11:43 AM: Started restoring cached go cache
4:11:43 AM: Finished restoring cached go cache
4:11:45 AM: Installing Go version 1.19.3 (requested 1.19.x)
4:11:50 AM: unset GOOS;
4:11:50 AM: unset GOARCH;
4:11:50 AM: export GOROOT='/opt/buildhome/.gimme/versions/go1.19.3.linux.amd64';
4:11:50 AM: export PATH="/opt/buildhome/.gimme/versions/go1.19.3.linux.amd64/bin:${PATH}";
4:11:50 AM: go version >&2;
4:11:50 AM: export GIMME_ENV="/opt/buildhome/.gimme/env/go1.19.3.linux.amd64.env"
4:11:50 AM: go version go1.19.3 linux/amd64
4:11:50 AM: Detected 0 framework(s)
4:11:50 AM: Installing missing commands
4:11:50 AM: Verify run directory
4:11:51 AM: ​
4:11:51 AM: ────────────────────────────────────────────────────────────────
4:11:51 AM:   Netlify Build                                                 
4:11:51 AM: ────────────────────────────────────────────────────────────────
4:11:51 AM: ​
4:11:51 AM: ❯ Version
4:11:51 AM:   @netlify/build 28.4.4
4:11:51 AM: ​
4:11:51 AM: ❯ Flags
4:11:51 AM:   baseRelDir: true
4:11:51 AM:   buildId: 638d61481c52d8229f600afd
4:11:51 AM:   deployId: 638d61481c52d8229f600aff
4:11:51 AM: ​
4:11:51 AM: ❯ Current directory
4:11:51 AM:   /opt/build/repo/docs
4:11:51 AM: ​
4:11:51 AM: ❯ Config file
4:11:51 AM:   No config file was defined: using default values.
4:11:51 AM: ​
4:11:51 AM: ❯ Context
4:11:51 AM:   production
4:11:51 AM: ​
4:11:51 AM: ────────────────────────────────────────────────────────────────
4:11:51 AM:   1. Build command from Netlify app                             
4:11:51 AM: ────────────────────────────────────────────────────────────────
4:11:51 AM: ​
4:11:51 AM: $ npm run build
4:11:51 AM: > build
4:11:51 AM: > vitepress build
4:11:51 AM: vitepress v1.0.0-alpha.29
4:11:52 AM: - building client   server bundles...
4:12:06 AM: warnings
4:12:06 AM:   One of the glob patterns doesn't match any files. Please remove or fix the following: {  "globDirectory": "/opt/build/repo/docs/.vitepress/dist",
4:12:06 AM:   "globPattern": "**/*.{js,css,html}",
4:12:06 AM:   "globIgnores": [
4:12:06 AM:     "**/node_modules/**/*",
4:12:06 AM:     "sw.js",
4:12:06 AM:     "workbox-*.js"
4:12:06 AM:   ]
4:12:06 AM: }
4:12:06 AM: 
4:12:08 AM: warnings
4:12:08 AM:   One of the glob patterns doesn't match any files. Please remove or fix the following: {  "globDirectory": "/opt/build/repo/docs/.vitepress/dist",
4:12:08 AM:   "globPattern": "**/*.{js,css,html}",
4:12:08 AM:   "globIgnores": [
4:12:08 AM:     "**/node_modules/**/*",
4:12:08 AM:     "sw.js",
4:12:08 AM:     "workbox-*.js"
4:12:08 AM:   ]
4:12:08 AM: }
4:12:08 AM: 
4:12:11 AM: ✓ building client   server bundles...
4:12:11 AM: - rendering pages...
4:12:11 AM: ✖ rendering pages...
4:12:11 AM: build error:
4:12:11 AM:  TypeError: Cannot read properties of undefined (reading 'replace')
4:12:11 AM:     at ReactiveEffect.fn (file:///opt/build/repo/docs/.vitepress/.temp/app.js:2934:25)
4:12:11 AM:     at ReactiveEffect.run (/opt/build/repo/docs/node_modules/@vue/reactivity/dist/reactivity.cjs.prod.js:159:25)
4:12:11 AM:     at ComputedRefImpl.get value [as value] (/opt/build/repo/docs/node_modules/@vue/reactivity/dist/reactivity.cjs.prod.js:1072:39)
4:12:11 AM:     at unref (/opt/build/repo/docs/node_modules/@vue/reactivity/dist/reactivity.cjs.prod.js:981:29)
4:12:11 AM:     at file:///opt/build/repo/docs/.vitepress/.temp/app.js:3019:21
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:251:17)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at ssrRenderComponent (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:621:12)
4:12:11 AM:     at file:///opt/build/repo/docs/.vitepress/.temp/app.js:3170:13
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:251:17)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at ssrRenderComponent (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:621:12)
4:12:11 AM:     at file:///opt/build/repo/docs/.vitepress/.temp/app.js:3245:15
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:251:17)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at ssrRenderComponent (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:621:12)
4:12:11 AM:     at file:///opt/build/repo/docs/.vitepress/.temp/app.js:3485:15
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:251:17)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at renderVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:296:22)
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:202:9)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at renderVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:296:22)
4:12:11 AM:     at renderComponentSubTree (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:260:13)
4:12:11 AM:     at renderComponentVNode (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:185:16)
4:12:11 AM:     at renderToString (/opt/build/repo/docs/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:447:26)
4:12:11 AM:     at render (file:///opt/build/repo/docs/.vitepress/.temp/app.js:4337:10)
4:12:11 AM:     at async renderPage (file:///opt/build/repo/docs/node_modules/vitepress/dist/node/serve-fcdc8868.js:41266:19)
4:12:11 AM:     at async Promise.all (index 1)
4:12:11 AM:     at async build (file:///opt/build/repo/docs/node_modules/vitepress/dist/node/serve-fcdc8868.js:42017:7)
4:12:11 AM: ​
4:12:11 AM: ────────────────────────────────────────────────────────────────
4:12:11 AM:   "build.command" failed                                        
4:12:11 AM: ────────────────────────────────────────────────────────────────
4:12:11 AM: ​
4:12:11 AM:   Error message
4:12:11 AM:   Command failed with exit code 1: npm run build
4:12:11 AM: ​
4:12:11 AM:   Error location
4:12:11 AM:   In Build command from Netlify app:
4:12:11 AM:   npm run build
4:12:11 AM: ​
4:12:11 AM:   Resolved config
4:12:11 AM:   build:
4:12:11 AM:     base: /opt/build/repo/docs
4:12:11 AM:     command: npm run build
4:12:11 AM:     commandOrigin: ui
4:12:11 AM:     environment:
4:12:11 AM:       - CI
4:12:11 AM:     publish: /opt/build/repo/docs/.vitepress/dist
4:12:11 AM:     publishOrigin: ui
4:12:12 AM: Caching artifacts
4:12:12 AM: Started saving node modules
4:12:12 AM: Finished saving node modules
4:12:12 AM: Started saving build plugins
4:12:12 AM: Finished saving build plugins
4:12:12 AM: Started saving pip cache
4:12:12 AM: Finished saving pip cache
4:12:12 AM: Started saving emacs cask dependencies
4:12:12 AM: Finished saving emacs cask dependencies
4:12:12 AM: Started saving maven dependencies
4:12:12 AM: Finished saving maven dependencies
4:12:12 AM: Started saving boot dependencies
4:12:12 AM: Finished saving boot dependencies
4:12:12 AM: Started saving rust rustup cache
4:12:12 AM: Finished saving rust rustup cache
4:12:12 AM: Started saving go dependencies
4:12:14 AM: Creating deploy upload records
4:12:12 AM: Finished saving go dependencies
4:12:14 AM: Build failed due to a user error: Build script returned non-zero exit code: 2
4:12:14 AM: Failing build: Failed to build site
4:12:14 AM: Failed during stage 'building site': Build script returned non-zero exit code: 2
4:12:14 AM: Finished processing build request in 59.909675574s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The document site need upgrade New site for Stylus
6 participants