Docker/AdventureLog
Docker/AdventureLog
1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-18 20:39:36 +02:00
Code Issues Releases Activity
AdventureLog/documentation
History
Sean Morley 0ea948c62c
Merge pull request #356 from seanmorley15/development 
AdventureLog v0.7.1
2024-11-13 09:06:32 -05:00
..
blog Add screenshots and better documentation 2024-08-01 21:06:50 -04:00
docs Add Umami Analytics documentation for configuration 2024-11-12 09:23:23 -05:00
src docs 2024-07-08 17:10:50 -04:00
static Refactor Docusaurus configuration and frontend components 2024-10-25 14:20:51 -04:00
.gitignore migration to new backend 2024-07-08 11:44:39 -04:00
babel.config.js migration to new backend 2024-07-08 11:44:39 -04:00
docusaurus.config.ts Add guides category to documentation and rename nginx migration guide 2024-11-11 23:46:22 -05:00
package.json Update nginx migration documentation and change package name to adventurelog-docs 2024-11-09 22:09:58 -05:00
pnpm-lock.yaml Bump http-proxy-middleware 2024-10-26 13:47:41 +00:00
README.md migration to new backend 2024-07-08 11:44:39 -04:00
sidebars.ts Add support link to documentation and format sidebar configuration 2024-11-11 23:38:35 -05:00
tsconfig.json migration to new backend 2024-07-08 11:44:39 -04:00

README.md

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.