116 lines
4.3 KiB
Markdown
116 lines
4.3 KiB
Markdown
# Presencode documentation
|
||
The Presencode documentation uses [Docusaurus](https://docusaurus.io).
|
||
|
||
# Commands
|
||
We use [make](https://www.gnu.org/software/make/).
|
||
## Installing dependencies
|
||
```plain
|
||
$ make install-deps
|
||
pnpm install
|
||
Downloading registry.npmjs.org/typescript/5.2.2: 7,23 MB/7,23 MB, done
|
||
WARN 1 deprecated subdependencies found: stable@0.1.8
|
||
Packages: +1088
|
||
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||
Progress: resolved 1089, reused 0, downloaded 1088, added 1088, done
|
||
node_modules/.pnpm/core-js-pure@3.35.0/node_modules/core-js-pure: Running postinstall script, done in 92ms
|
||
node_modules/.pnpm/core-js@3.35.0/node_modules/core-js: Running postinstall script, done in 92ms
|
||
|
||
dependencies:
|
||
+ @docusaurus/core 3.1.0
|
||
+ @docusaurus/plugin-content-docs 3.1.0
|
||
+ @docusaurus/plugin-sitemap 3.1.0
|
||
+ @docusaurus/preset-classic 3.1.0
|
||
+ @mdx-js/react 3.0.0
|
||
+ clsx 2.1.0
|
||
+ prism-react-renderer 2.3.1
|
||
+ react 18.2.0
|
||
+ react-dom 18.2.0
|
||
|
||
devDependencies:
|
||
+ @docusaurus/module-type-aliases 3.1.0
|
||
+ @docusaurus/tsconfig 3.1.0
|
||
+ @docusaurus/types 3.1.0
|
||
+ typescript 5.2.2 (5.3.3 is available)
|
||
|
||
Done in 18.1s
|
||
```
|
||
## Development web server
|
||
This will start [a development server](http://localhost:3000) that supports hot reloading.
|
||
```plain
|
||
$ make test
|
||
pnpm run start --hot-only --no-open
|
||
|
||
> docs@0.0.0 start /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
|
||
> docusaurus start "--hot-only" "--no-open"
|
||
|
||
(node:138150) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
|
||
(Use `node --trace-deprecation ...` to show where the warning was created)
|
||
[INFO] Starting the development server...
|
||
[SUCCESS] Docusaurus website is running at: http://localhost:3000/
|
||
|
||
✔ Client
|
||
Compiled successfully in 4.40s
|
||
|
||
client (webpack 5.89.0) compiled successfully
|
||
```
|
||
## Building the documentation
|
||
This will output the built documentation to `out/`. Simply point a web server to it and you're done.
|
||
```plain
|
||
$ make build
|
||
pnpm run build --out-dir out
|
||
|
||
> docs@0.0.0 build /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
|
||
> docusaurus build "--out-dir" "out"
|
||
|
||
(node:139592) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
|
||
(Use `node --trace-deprecation ...` to show where the warning was created)
|
||
[INFO] [en] Creating an optimized production build...
|
||
|
||
|
||
✔ Client
|
||
|
||
|
||
✔ Server
|
||
Compiled successfully in 11.36s
|
||
|
||
|
||
✔ Client
|
||
|
||
|
||
● Server █████████████████████████ cache (99%) shutdown IdleFileCachePlugin
|
||
stored
|
||
|
||
[SUCCESS] Generated static files in "out".
|
||
[INFO] Use `npm run serve` command to test your build locally
|
||
```
|
||
## Cleaning the directory
|
||
This will remove the `out/` directory containing the built website aswell as Docusaurus files.
|
||
```plain
|
||
$ make clean
|
||
pnpm run clear
|
||
|
||
> docs@0.0.0 clear /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
|
||
> docusaurus clear
|
||
|
||
(node:140318) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
|
||
(Use `node --trace-deprecation ...` to show where the warning was created)
|
||
[SUCCESS] Removed the generated folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/.docusaurus".
|
||
[SUCCESS] Removed the Webpack persistent cache folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/node_modules/.cache".
|
||
rm -rf "out" ".docusaurus" ".cache-loader"
|
||
```
|
||
### More cleaning
|
||
This will remove the `node_modules/` and `pnpm-lock.yaml` directory aswell.
|
||
```plain
|
||
$ make clean-extra
|
||
pnpm run clear
|
||
|
||
> docs@0.0.0 clear /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
|
||
> docusaurus clear
|
||
|
||
(node:141571) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
|
||
(Use `node --trace-deprecation ...` to show where the warning was created)
|
||
[SUCCESS] Removed the generated folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/.docusaurus".
|
||
[SUCCESS] Removed the Webpack persistent cache folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/node_modules/.cache".
|
||
rm -rf "out" ".docusaurus" ".cache-loader"
|
||
rm -rf "node_modules" "pnpm-lock.yaml"
|
||
```
|