| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
The website - https://hyperdom.org - hosted on github-pages (gh-pages branch).
It's assembled together from individual .md files at runtime (that is, when user navigates to the website) by docsify
Hyperdom docs website features embedded codesanbox examples. Those live in /docs/codesandbox and turned into iframes at runtime as well.
A special link in the markdown source facilitates the trick. E.g.:
[codesandbox](https://codesandbox.io/embed/github/featurist/hyperdom/tree/master/docs/codesandbox/get-started-init?fontsize=14)
will result in a codesandbox iframe containing the project from /docs/codesandbox/get-started-init
/docs/codesandbox are also used to populate code example blocks (not to be mixed with runnable examples).
This is done with another magic link. E.g.:
[view code](docs/codesandbox/get-started-events/src/browser/app.jsx#L3)
This it NOT a runtime thing though and it requires preprocessing. It's built into yarn dev-website and yarn publish-website so you don't need to do anything.
yarn docs
This runs the above and then starts serving ./docs/index.html
You could use entr:
ls docs/src/*.md | entr yarn populate-code-blocks
The following updates gh-pages branch with the difference between gh-pages and your local code:
yarn publish-website
| Back | FazBrowse Home | New Git URL |