Documentation repo for Scribe. Built using Docusaurus 2.
- Node.js 12+
- npm or Yarn (Ideally, Yarn, but npm works too.)
yarn install
yarn start
starts a local development server on http://localhost:3000 and opens up a browser window. Most changes are reflected live without having to restart the server.
Note that the search bar won't be shown at all in local dev mode.
yarn build
creates a production build in the build
directory, which can then be served on localhost:3000 with yarn serve
.
The site is currently deployed to scribe.knuckles.wtf via Render. The site will build and auto-deploy on push to any branch in the repo.
Docs are Markdown files, located within laravel/
and nodejs/
. Images and assets go in static/
. A few custom React components, styles and pages are in src/
.