extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2025-01-23 06:18:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Write down how this works while I remember

Browse Source
This commit is contained in:
nathan 2023-09-25 08:22:41 -06:00
parent 8b5819094d
commit e504573269
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/README.md Normal file
View File

@ -0,0 +1,12 @@
## Notes on automatic documentation
This is a project in itself. Here's how the pieces fit together:
+ `build:dev` package script calls `/doc/scripts/build.mjs` which is responsible for calling the individual pieces. We
pass files to the subprocesses, but options are set in a separate config file.
+ `/doc/scripts/metadata.mjs` extracts the component information
using [CEM](https://custom-elements-manifest.open-wc.org/), and stores it to `/doc/dist/custom-elements.json`
+ `/doc/scripts/etemplate2/eleventy.config.cjs` uses [11ty](11ty.dev) to build a documentation site, from the
subdirectories in `/doc/etemplate2`, and stores it to `/doc/dist/site`
If a component doesn't show up, it's probably not in the manifest.