Skip to content

jmgilman/dev

Repository files navigation

Developer's Handbook

This repository contains the source for my personal development handbook. The deployed version of it can be seen here.

Development

All dependencies are bundled in a Nix flake:

nix develop

If you have direnv installed:

direnv allow

If you don't want to use Nix, you'll need to ensure you have the following dependencies available:

Then install the Python dependencies:

poetry install

Building

The handbook is built using MkDocs. To build the handbook:

mkdocs build

The site contents will be availabe in the site/ subdirectory.

Publishing

The project uses Netlify for deployment. Any pushes to the master branch are automatically deployed to Netlify.

Contributing

Check out the issues for items needing attention or submit your own and then:

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

About

Personal development handbook

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors