@aiou/docs-templates

vuepress template

Usage no npm install needed!

<script type="module">
  import aiouDocsTemplates from 'https://cdn.skypack.dev/@aiou/docs-templates';
</script>

README

doc - template

Note

  • maybe need to custom prepublishOnly script in package.json and other package info
  • need reconfig baseUrl and paths in tsconfig.json

rules

DO NOT

/docs
  /a
  a.md
  b.md

DO NOT

/docs
  /a
    README.md // wrong
    a.md // right

DO NOT

/docs
  /中文 // just eng
    /中文 or 英文 // all is ok

DO NOT

/docs
  /a
    /b
      readme.md // rename to a.md