Giter VIP home page Giter VIP logo

docify's Introduction

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

docify's People

Contributors

ggdream avatar

Stargazers

avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.