This is the Lone Rock Point Developer Playbook. The purpose is to document the way we do work. It is not meant to be final, rather it should be continuously updated.
This project uses github pages - githubs static page "hosting" option. These pages are built with Jekyll using markdown.
Jekyll takes markdown files and mixes it with a theme to generate static html. To update content in this repo you need to update the appropriate .markdown file.
index.markdown functions as a table of contents and contains tables with links to other markdown files. Most other markdown files will contain headings. These become IDs when Jekyll is run.
Example: this [Namespaces](code#namespaces) becomes a link to the code markdown file at the namespaces heading.
YOU ONLY NEED TO CHANGE MARKDOWN FILES, GITHUB WILL HANDLE THE BUILD AND EJECT THE NEW STATIC FILES FOR YOU.
You only need to run a build if you are trying to see how your changes appear before merge.
Because this is Jekyll it runs on ruby. I have found local ruby tooling to be difficult so I prefer to work on this project in github codespaces. You are welcome to set up your local dependencies to make the following work.
In Codespaces:
- Open the terminal and run
bundle install - Run the command
jekyll serve - Codespaces will pop up a modal linking you to a testing build.
- Make changes to markdown files.
- Reload the test build to confirm the changes are what you expected.
If you do want to run this locally on MacOS, do the following:
- In Terminal, run
brew install rbenv - Initialize this by running
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrcthensource ~/.zshrc - Quit Terminal and restart it
- Next, run
rbenv install 3.2.3andrbenv global 3.2.3 - Install the bundler using
gem install bundler - Now, CD into this repo or open terminal in the repo using an IDE and run
bundle install - Finally, run
bundle exec jekyll serve
The local site should be available at http://127.0.0.1:4000/