learn-to-code
learn-to-code copied to clipboard
MichaelCurrin
Convert to static site for readability and menus
Consider what to do with scripts which are meant to be run locally or as a webserver. Perhaps the resource docs can be moved to a separate repo.
Consider the repeated format of resources and even install steps could be standardized and moved to Jekyll templating. With markdown files or data files.
See my coding blog post for options.
One of the important things is automatically building menus.
To use something with a build other than Jekyll, look at Netlify.
Use code theme.
This is low priority though because it is still presentable and usable as is.
Docsify vs Jekyll
Consider how to avoid nesting menus too deeply And how to make sidebar not require manual updating.
Also consider navbar in the top and details on the sidebar, like Docsify.
Jekyll has a menu plugin and also its easy enough to loop over pages within the current section. That can be a menu on a section page rather than just navbar. Nested droplist menu won't be nice.
Jekyll is nice for repeated structure and data can even go in metadata - that can be edited in Jekyl Admin. Docsify menus are automatic within a section (and each language could be section on the top or left) but then would need to make a super long file for each to get the menus. Or have to manually update a sidebar file which is not good for large project.
Use lowercase and underscore names for files and folders. It makes everything consistent and easy to link.
This means that menu configuration or some index/README in a folder with no direct files might be needed to name a folder on the frontend.
Jekyll would be great for using file linking to test broken URLs.
Then using a Ruby tester for external URLs.
An auto placement of external link fontawesome icon will help differentiate between internal and external URLs.
Any links to Github repos (homepage) could also be supplemented with icon or badge
See if the templating and theme and admin view can be common between this and cheatsheet repo. Cheatsheets needs to be on its own so its a quick reference, but they can look consistent and share a common 3rd theme repo that I write, which is built on another theme.
Jekyll might be a good choice here for templating.
Jekyll handles templating easily.
Perhaps Docsify and MkDocs can do that but I haven't covered that or there are plugins needed.
Jekyll can also check broken links - otherwise use Netlify or similar CI check or that Ruby tool.