https://github.com/ggdream/docify
A flutter package that can quickly build a document website
https://github.com/ggdream/docify
doc-website flutter-web generatepress
Last synced: about 1 month ago
JSON representation
A flutter package that can quickly build a document website
- Host: GitHub
- URL: https://github.com/ggdream/docify
- Owner: ggdream
- License: mit
- Created: 2022-04-30T05:06:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-03T03:11:09.000Z (about 4 years ago)
- Last Synced: 2025-03-20T21:08:18.632Z (about 1 year ago)
- Topics: doc-website, flutter-web, generatepress
- Language: Dart
- Homepage:
- Size: 50.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Docify
A package that can quickly build a document website.
## Steps
### 1. Add the dependience and write main function
```dart
// file: lib/main.dart
import 'package:docify/docify.dart';
void main() => Docify().run();
```
### 2. Write information according to the rules
~~~yaml
# file: assets/docify/docify.yaml
name: 思思的博客
icon: logo.png
declare: 欢迎来到这里
center:
- title: 测试1
image: 'https://raw.githubusercontent.com/mocaraka/assets/main/picture/326.jpg'
content: test1
- title: 测试2
image: 'https://raw.githubusercontent.com/mocaraka/assets/main/picture/330.jpg'
content: test2
router:
mode: history
routes:
- name: a
path: test1.md
children:
- name: b
path: test2.md
- name: b
path: test3.md
- name: c
path: test4.md
~~~
### 3. Prepare documentation files
~~~yaml
# dir: assets/docify/docs/
~~~
## Example
[See here](https://github.com/ggdream/docify/tree/main/example)