Skip to content

ccapeng/doc-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HTML Document with React

It's for some well formatted html document when you want to put them together.

There are some other react base document management. Gatsby is another kind of headless CMS, but still need to have strong skill of react. In the project, you will find how easy to incorporate some small html files into a full document.

In the project directory, you can run npm start.
Live demo in heroku

How to put up your document?

  • Put all resources (html, css, image) into public/assets.

  • Define docs.json under public/assets like the following :

    {
      "header": "UI Componenet Document",
      "sections" : [
        {
          "id" : "components",
          "subheader" : "Components", 
          "topics" : [
            { 
              "name" : "Avatar", 
              "id" : "avatar", 
              "items" : [
                {
                  "title" : "Icon",
                  "url" : "assets/docs/components/avatar/avatar-icon-md.html"
                },
                ...
              ]
            },
            ...
          ]
        }
        ...
      ]
    }
    
  • It's UI componenet docuemnt in the project.
    All components are base on bootstrap.

About

Build your document. See format in public/assets/docs.json

Resources

Stars

Watchers

Forks

Packages

No packages published