diff --git a/docs/src/index.md b/docs/src/index.md index b340110..124493b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -31,14 +31,14 @@ Add this where you want the iFrame to be: ## For Developers -To locally deploy the website and start coding, follow the [setup guide](../setup). +To locally deploy the website and start coding, follow the [setup guide](./setup). Once you have the website setup locally, you now have access to the following: -- Deploy the website to Heroku (guide [here](../deployment)) +- Deploy the website to Heroku (guide [here](./deployment)) - Manually run commands and download data through the `flask shell`. - Make changes to the predictive model, including revising its coefficients. (Guide is currently WIP) -- (Advanced) Make other changes to the website. +Make other changes to the website. ## To Deploy diff --git a/docs/src/setup.md b/docs/src/setup.md index 8643504..fac22e0 100644 --- a/docs/src/setup.md +++ b/docs/src/setup.md @@ -79,7 +79,7 @@ After you get everything set up, you should run the website at least once. To do this, run the following: === "Windows (CMD)" - ```shell + ```cmd uv venv .venv .\.venv\Scripts\activate.bat uv pip sync requirements.txt diff --git a/mkdocs.yml b/mkdocs.yml index 3dd6f08..ffbd273 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,9 +45,9 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.superfences: custom_fences: - - name: mermaid - class: mermaid - format: "!!python/name:pymdownx.superfences.fence_div_format" + - name: mermaid + class: mermaid + format: "!!python/name:pymdownx.superfences.fence_code_format" - sane_lists extra: flagging_website_url: https://crwa-flagging.herokuapp.com @@ -58,5 +58,3 @@ extra: link: https://www.meetup.com/Code-for-Boston/ - icon: fontawesome/brands/twitter link: https://twitter.com/codeforboston -extra_javascript: -- https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js