Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme.md with setup "Working on the content" instructions for armbian 24.5.1  #437

Merged
merged 3 commits into from
Jul 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,45 @@ See the [document template](.github/DOCUMENT_TEMPLATE.md) before you writing any

## Working on the content

### Prerequisites

Ensure you have Python and the necessary development packages installed:

```bash
sudo apt-get update
sudo apt-get install python3 python3-pip python3-venv python3.11-dev
```
### Cloning the Repository

Next, clone the Armbian documentation repository:

```bash
git clone https://github.com/armbian/documentation
cd documentation
```

### Setting Up the Environment

Set up a Python virtual environment to isolate the project dependencies:

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs build --clean && mkdocs serve
```

You will be able to make edits to existing files and observe the results in real time.
### Building and Serving the Documentation

After changing text in an existing file, use this command to rebuild and view the documentation:
To build and serve the documentation locally, allowing you to make edits and observe the results in real time, use:

`mkdocs build --clean && mkdocs serve`
```bash
mkdocs build --clean && mkdocs serve
```

After adding a new file, either hand-edit `mkdocs.yml`, or re-run `tools/mkArmbianDocs.py` **unless making changes to the structure of the `docs/` folder**. (See below)
You will be able to make edits to existing files and observe the results in real time.

## Generate tools
After adding a new file, either hand-edit `mkdocs.yml`, or re-run `tools/mkArmbianDocs.py` **unless making changes to the structure of the `docs/` folder**. (See below)

### mkArmbianDocs.py
Generate `mkdocs.yml` based on the contents of `docs/` folder
Expand Down