This guide is internal and a work in progress. It assumes familiarity with npm
,
pip
, git
, mkdocs
, and typical development workflows.
-
Clone this repository
git clone https://github.com/codesue/walt.git
-
Navigate to the directory
cd walt
-
Install dependencies
If you're making updates to
walt.css
, run:npm install
If you're making changes to
mkdocs-walt
, run the following in a Python virtual environment:cd mkdocs pip install -e .
Open reference.html in a browser. Make changes to walt.css and refresh the tab with reference.html to preview your changes.
Lint your changes to make sure they follow style guidelines:
npm run test
When you're satisfied with your changes, run:
npm run build
Run the mkdocs development server:
mkdocs serve
Make changes to mkdocs-walt and preview them in a browser.
/
: various config and informational files.github/
: GitHub Actions workflowsassets/
: assets such as preview images for the projectdocs/
: project documentation, mkdocs examplemkdocs/
: Walt theme for MkDocs Python package