Skip to content

Nelusha-W/document-everything

 
 

Repository files navigation

Julia Documents Things

Netlify Status

This is documentation of various useful things I've figured out and will inevitably forget if I don't write them down.

Usage

Local setup:

bundle update
bundle install

Run locally:

bundle exec jekyll serve

Occasionally update your packages:

bundle update

Netlify builds from the master branch. (You can use GitHub Pages, but you will lose the "last updated" feature on posts, because GitHub Pages doesn't allow external plugins.)

Credits

This uses the very slick Just the Docs Jekyll theme.

Images are from unDraw, sometimes modified by me.

Things I want to add

  • For long pages (in desktop view, at least), a running within-page table of contents along the right side
    • Also should involve smooth-scrolling between sections when you click on the links
    • And dynamically updating the TOC to show which section is currently active (possibly helpful)
  • On the home page, add links to most recently posted & most recently updated pages

Notes

For Ruby 2.7 and Jekyll 3.8.5, you get a billion warnings printed to the console. Until Just The Docs supports Jekyll 4.0, run this instead of the above command:

bundle exec jekyll serve 2>/dev/null

About

Documenting projects, research, and tips & tricks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 40.4%
  • SCSS 32.2%
  • HTML 17.4%
  • JavaScript 10.0%