/labs-guides

Guides to various aspects of the Labs experience

MIT LicenseMIT

Labs Guides

Build mkdocs and Publish to Github Pages

This repository contains the Lambda School Labs Guides. The Guides are in MarkDown format and structured to be converted into a static HTML website using the MkDocs site generator.

Generated Website

Contributions

Contributions, suggestions and comments are welcome from anyone in the form of a PR and github issues. The Pull Request will be reviewed by Lambda Labs Engineering staff and if approved, will become part of the Labs Guides.

Getting Started with local dev

All steps below are based on the use of pipenv

  • on mac: > brew install pipenv

The github actions still require a requirements.txt file so if you add anything to the Pipfile you will need to generate a new requirements.txt file

  • > pipenv run pipenv_to_requirements -f
  • > pipenv install --dev
  • > pipenv shell
    • start a shell with a virtual environment
  • Build the site
    • #> mkdocs build
  • install markdown linter
    • > npm install -g markdownlint-cli
  • run the linter before commits
    • > markdownlint -c .markdownlint.json .