Contributing

New feature, bug fix, new language, new howto, typo fix; everything is fine.

Note

issue -> discuss -> fork -> PR

Code

Prepare

git clone https://github.com/rexzhang/asgi-webdav.git
cd asgi-webdav
pip install -U -r requirements/dev.txt

Run Dev Server

python -m asgi_webdev --dev

Documentation

Create a new language translation

Example

cp docs/index.en.md docs/index.ru.md

Update MkDocs's config file

mkdocs.txt example

      languages:
        en: English
        ru: русский
        zh: 中文
      nav_translations:
        zh:
          Home: 首页
          Setup: 配置
          Reference: 资料
          Trouble Shooting: 故障处理

Ref

• ISO 639-1 language code
• MkDocs's i18n plugin

Create a new howto

nano docs/howto/howto-this-is-a-new-howto.en.md

Preview

pip install -U -r requirements/mkdocs.txt
mkdocs serve

---

Last update: 2022-12-01