The theme/classic
is used. It is build with infima.
Add or edit new docs in docs/. This will have effect to all different "Versions" since their versions are only simlinked.
To enable specific docs to a course, either add manually a symlink, or call the bash script bin/enable.
E.g. to enable the contents of [docs/byod_basics] for the course 24i:
bin/enable byod_basics 24i
To disable docs from a course, either remove the simlink manually, or call the bash script bin/disable:
E.g. to disable the contents of [docs/byod_basics] for the course 24i:
bin/disable byod_basics 24i
yarn install
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Either
- Setup github actions to deploy your page on each push to the main branch.
- or setup a drone runner to build the project and deploy it to gh-pages.
- Add a
CNAME
File to the static directory - Disable CLoudflare "DNS Proxy" temporarly
- Deploy
- Let Github generate SSL certificates for you
- Check "Enforce https:"
- Re-Enable DNS Proxy on Cloudflare again.
postgres -D /usr/local/var/postgres
Make sure to check the compatibility after a docusaurus upgrade:
Component | Swizzle |
---|---|
DocVersionBadge | yarn run swizzle @docusaurus/theme-classic DocVersionBadge --eject --typescript |
NavbarItem | yarn run swizzle @docusaurus/theme-classic NavbarItem --eject --typescript |
NotFound (safe) | yarn run swizzle @docusaurus/theme-classic NotFound --eject --typescript |
docusaurus.config.js
, then search for it in the project, to change all occurances!