study-zero / newbie

https://study-zero.github.io/newbie/
1 stars 0 forks source link

newbie study docs

sources

sphinx/source

build

rye sync
make clean && make html

serve locally(using output)

python -m http.server -d docs 4001
# use your own port

contribution

add sidebar contents

vi sphinx/source/index.rst
# append some toctree

add posts on kuar

A post must have a title(h1)

vi sphinx/source/kuar/---.md
# vi sphinx/source/kuar/---.rst

How to add post

  1. git clone https://github.com/study-zero/newbie.git
  2. cd newbie
  3. rye sync
  4. vi sphinx/source/kuar/---.md
  5. make clean & make html
  6. git add .
  7. git commit -m "commit message"
  8. git push origin main

tools