Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.13 KB

README.md

File metadata and controls

18 lines (13 loc) · 1.13 KB
Raw

Agrisemantics

Backend for https://agrisemantics.org

Build the website using MkDocs

  • Install mkdocs on your machine (see installation instructions).
  • Install the Windmill theme (pip install mkdocs-windmill).
  • Run the command mkdocs gh-deploy (or use deploy.sh).
    • This command creates (or refreshes) the website at https://agrisemantics.org.
    • The command must be run from the root directory of this repo.
    • Behind the scenes, mkdocs gh-deploy builds HTML docs from the Markdown sources, uses the ghp-import tool to commit them to the gh-pages branch, and pushes the gh-pages branch to GitHub.

Using Git Large File Storage

  • Install in every local copy of the repo with with git lfs install
  • See .gitattributes for list of file types stored using Github LFS.
    • Initially, ZIP files are stored with LFS.