armbian / documentation

Armbian Linux Documentation
https://docs.armbian.com
GNU General Public License v3.0
175 stars 164 forks source link

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

Open Tearran opened 1 week ago

Tearran commented 1 week ago

System

Armbian 24.5.1 Bookworm with Linux 6.6.31-current-meson64 added bash procedure used to build document in readme. Followed readme tutorial readme bash procedure did not work for me on fresh image of Armbian 24.5.1 Bookworm

what procedure did worked

{
sudo apt-get update
sudo apt-get install python3 python3-pip python3-venv python3.11-dev
}

followed by

{
git clone https://github.com/armbian/documentation
cd documentation
python3 -m venv $HOME/.local/armbian-docs-env 
source $HOME/.local/armbian-docs-env/bin/activate
$HOME/.local/armbian-docs-env/bin/pip install -r requirements.txt
mkdocs build --clean && mkdocs serve
}

Lastly

This shows a the expected webpage on given url:port

python3 tools/mkArmbianDocs.py && mkdocs build 
mkdocs serve

resulted


chromium  http://127.0.0.1:8000/User-Guide_Armbian-ConfigNG/
image
igorpecovnik commented 1 week ago

i think this part can be merged - perhaps fix the title to say more specific what it does.

Tearran commented 1 week ago

@rpardini your suggestion makes practical sense. and looking at existing .gitignore made compatible changes. quick test had similar results.

{
git clone https://github.com/armbian/documentation
cd documentation
python3 -m venv .venv
source .venv/bin/activate
}