pixelastic / norska

🏔️ Custom SSG using Pug, Webpack, PostCSS and Tailwind.
https://projects.pixelastic.com/norska/
MIT License
8 stars 0 forks source link

The order of the README symlink should be inverted #79

Closed pixelastic closed 3 years ago

pixelastic commented 3 years ago

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)

image

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.

pixelastic commented 3 years ago

Actually, maybe it should be an issue for monorepoify

pixelastic commented 3 years ago

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.

pixelastic commented 3 years ago

With ./docs/src/index.md the unique source of truth and others symlinks:

image

image

pixelastic commented 3 years ago

Here is what works:

This works both on GitHub and Yarn.

This needs to be done on those websites:

pixelastic commented 3 years ago

Actually, instead of dealing with symlinks, I should have both README.md and lib/README.md be generated from docs/src/index.md

pixelastic commented 3 years ago

Fixed