diff --git a/Conversion Process.md b/Conversion Process.md index adddafe..f8b7465 100644 --- a/Conversion Process.md +++ b/Conversion Process.md @@ -32,9 +32,9 @@ This works in several main phases: ### Setting up the new system -1. Install `mkdocs` (which will be used to serve the resulting .md files) and `mkdocs-material` (the theme): +1. Install `mkdocs`, `mkdocs-material` (the theme), and any required plugins: ```sh - pip install mkdocs mkdocs-material + pip install -r requirements.txt ``` ### Setting up the repo for deployment @@ -72,6 +72,10 @@ Instead of initializing Mkdocs from scratch, we're going to just copy files over 2. Update anything related to "After Effects Scripting Guide" and make it relevant for this repo - `./.mkdocs.yml` - `./docs/index.md` +3. Open a terminal to the root folder, and run the below command to serve the docs + ```sh + mkdocs serve + ``` --- diff --git a/readme.md b/readme.md index f2eaf75..1ed2326 100644 --- a/readme.md +++ b/readme.md @@ -18,12 +18,18 @@ This project is written in [Markdown](https://en.wikipedia.org/wiki/Markdown), s Before pushing to the online project (or submitting a PR), we ask that you develop & test the project locally to ensure the result is what you'd expect. -To build locally, follow [Docsify's "Quick Start" guide](https://docsify.js.org/#/quickstart). +To build locally: -- Install node.js & npm -- Install docsify -- Navigate to the project directory and use the command `docsify serve ./docs` -- Open your browser to `http://localhost:3000` to view the live-updating docs +- Install python & pip +- From a terminal, navigate to the project directory and run the following command to install dependencies: +```sh +pip install -r requirements.txt +``` +- When done, run the following command to serve the docs: +```sh +mkdocs serve +``` +- Open your browser to the provided url (`http://127.0.0.1:8000`) by default to view the live-updating docs --- diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3199625 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +mkdocs +mkdocs-material +mkdocs-git-revision-date-localized-plugin