Skip to content

Commit

Permalink
Add requirements.txt; update readme and conversion process with insta…
Browse files Browse the repository at this point in the history
…llation and serving instructions
  • Loading branch information
zlovatt committed Nov 8, 2024
1 parent 495a687 commit ef7793a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
8 changes: 6 additions & 2 deletions Conversion Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```

---

Expand Down
16 changes: 11 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs
mkdocs-material
mkdocs-git-revision-date-localized-plugin

0 comments on commit ef7793a

Please sign in to comment.