Closed pixelastic closed 3 years ago
Actually, maybe it should be an issue for monorepoify
Actually, aberlaas
has a readme
feature that can generate a readme from a template and a set of markdown files. We can use that to generate the root and lib readme from the docs index whenever the docs index is modified.
With ./docs/src/index.md
the unique source of truth and others symlinks:
Here is what works:
docs/src/index.md
fileREADME.md
at the rootaberlaas readme
to generate the root readmeln -s README.md ./lib/README.md
This works both on GitHub and Yarn.
This needs to be done on those websites:
Actually, instead of dealing with symlinks, I should have both README.md
and lib/README.md
be generated from docs/src/index.md
Fixed
Today, the
./README.md
and./lib/README.md
are symlinks to./docs/src/index.md
. This does not display well on GitHub (it does work well on Yarn, though)The order of the links should be changed. The main file should be the root
./README.md
and the./lib/README.md
and./docs/src/index.md
should point to it.