Repository navigation
Static docs - #1749
Static docs#1749
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/markedjs/markedjs/3jcxds3ly |
|
@UziTech @joshbruce Do we want to use For example, it would change We could even rename this to just |
|
I prefer clean urls but I don't know if there is a benefit one way or the other. We do need to make sure that old links are properly redirected. |
|
I prefer clean urls too. We'll have to do the redirect on the client side since it needs to read the hash. I'll add that soon 👍 |
|
I also prefer cleaner URLs from a UX perspective. Email link doesn't say https://marked.org/?page=12 but /play-with-marked or something - totally making stuff up as I do the inbox zero thing before a meeting. |
| "lint": "eslint --fix bin/marked .", | ||
| "build:reset": "git checkout upstream/master lib/marked.js lib/marked.esm.js marked.min.js", | ||
| "build": "npm run rollup && npm run minify", | ||
| "build:docs": "node build-docs.js", |
There was a problem hiding this comment.
Does this have to be called manually any time the docs are changed? Should we run this in the Build step on merge?
There was a problem hiding this comment.
We don't commit the docs output so it doesn't need to run unless you want to see the docs output.
Would you prefer I rename this script to vercel-build instead of build:docs so its clear its for Vercel?
There was a problem hiding this comment.
How does vercel know to run npm build:docs to get the output? and when does it run (on every PR, on every commit to master)?
There was a problem hiding this comment.
The build command is configured here: https://vercel.com/markedjs/markedjs/settings
It runs every git push regardless of the branch. The master branch gets the production domain, https://marked.js.org, and PRs get the preview domains such as https://markedjs-git-static-docs.markedjs.vercel.app
|
Do we have documentation on how the documentation is built and where a markedjs member would go to edit it? I like the idea of being able to use server side functions for the docs but I also like the simplicity of github pages and having all of the code/settings in a central place. |
|
@UziTech You would go to https://vercel.com to edit project settings and https://vercel.com/docs for documentation. It's arguably easier for a new user who has not used either GitHub Pages or Vercel before, because Vercel adds links to the PR so you know where it was deployed and which project to edit. |
|
🎉 This PR is included in version 1.1.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
npm run build:docscleanUrls<title>to each pageContributor
Committer
In most cases, this should be a different person than the contributor.