ggdream / docify

A flutter package that can quickly build a document website

Docify

A package that can quickly build a document website.

Steps

1. Add the dependience and write main function

// file: lib/main.dart
import 'package:docify/docify.dart';

void main() => Docify().run();

2. Write information according to the rules

# 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

# dir: assets/docify/docs/

Example

See here