39 lines
1007 B
Markdown
39 lines
1007 B
Markdown
# KB Markdown Importer
|
|
|
|
WordPress plugin for importing GitLab based Markdown documentation into a versioned customer portal knowledgebase.
|
|
|
|
## Expected GitLab project structure
|
|
|
|
Each product has one GitLab project. Each documentation version is represented by a branch, for example `v1.0.0`, `v1.1.0` or `v2.0.0`.
|
|
|
|
```text
|
|
doku.md
|
|
stepbystep.md
|
|
faq.md
|
|
doku.yml
|
|
images/
|
|
screenshot.png
|
|
```
|
|
|
|
Required:
|
|
|
|
- `doku.md`
|
|
- `stepbystep.md`
|
|
- `images/`
|
|
|
|
Optional:
|
|
|
|
- `faq.md`
|
|
- `doku.yml` for title, version and navigation order
|
|
|
|
## Features
|
|
|
|
- GitLab settings and connection test in the WordPress admin.
|
|
- Custom post type `kb_doc_page`.
|
|
- Taxonomies for products, versions and components.
|
|
- Manual GitLab sync for projects, version branches, Markdown pages and images.
|
|
- WordPress-native Markdown rendering with internal `.md` link rewriting.
|
|
- Frontend routes under `/docs/`.
|
|
- Shortcodes: `[kb_docs]`, `[kb_docs_index]`, `[kb_product_index product="..."]`, `[kb_search]`.
|
|
- Import logs without exposing secrets.
|