Update docs README.md and config

(this is embarrasing)
This commit is contained in:
JeremyStar™ 2024-05-11 23:27:35 +02:00
parent ea31c64674
commit a73ccc0305
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
2 changed files with 4 additions and 91 deletions

View file

@ -1,116 +1,29 @@
# Presencode documentation # CORE Framework documentation
The Presencode documentation uses [Docusaurus](https://docusaurus.io). The CORE Framework documentation uses [Docusaurus](https://docusaurus.io).
# Commands # Commands
We use [make](https://www.gnu.org/software/make/). We use [make](https://www.gnu.org/software/make/).
## Installing dependencies ## Installing dependencies
```plain ```plain
$ make install-deps $ 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 ## Development web server
This will start [a development server](http://localhost:3000) that supports hot reloading. This will start [a development server](http://localhost:3000) that supports hot reloading.
```plain ```plain
$ make test $ 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 ## Building the documentation
This will output the built documentation to `out/`. Simply point a web server to it and you're done. This will output the built documentation to `out/`. Simply point a web server to it and you're done.
```plain ```plain
$ make build $ 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 ## Cleaning the directory
This will remove the `out/` directory containing the built website aswell as Docusaurus files. This will remove the `out/` directory containing the built website aswell as Docusaurus files.
```plain ```plain
$ make clean $ 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 ### More cleaning
This will remove the `node_modules/` and `pnpm-lock.yaml` directory aswell. This will remove the `node_modules/` and `pnpm-lock.yaml` directory aswell.
```plain ```plain
$ make clean-extra $ 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"
``` ```

View file

@ -4,7 +4,7 @@ import type * as Preset from "@docusaurus/preset-classic";
const config: Config = { const config: Config = {
title: "CORE Framework", title: "CORE Framework",
url: "https://core.jstm.staropensource.de", url: "https://core.staropensource.de",
baseUrl: "/", baseUrl: "/",
favicon: "dist/core.png", favicon: "dist/core.png",