Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert to static site for readability and menus #4

Open
MichaelCurrin opened this issue Dec 11, 2019 · 10 comments
Open

Convert to static site for readability and menus #4

MichaelCurrin opened this issue Dec 11, 2019 · 10 comments

Comments

@MichaelCurrin
Copy link
Owner

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.

@MichaelCurrin
Copy link
Owner Author

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.

@MichaelCurrin
Copy link
Owner Author

This is low priority though because it is still presentable and usable as is.

@MichaelCurrin
Copy link
Owner Author

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.

@MichaelCurrin
Copy link
Owner Author

Consider moving everything to a central learntocode directory.

@MichaelCurrin
Copy link
Owner Author

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.

@MichaelCurrin
Copy link
Owner Author

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.

@MichaelCurrin
Copy link
Owner Author

Jekyll would be great for using file linking to test broken URLs.

Then using a Ruby tester for external URLs.

@MichaelCurrin
Copy link
Owner Author

MichaelCurrin commented Apr 8, 2020

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

@MichaelCurrin
Copy link
Owner Author

MichaelCurrin commented Apr 8, 2020

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.

@MichaelCurrin
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant