Giter Site home page Giter Site logo

team-wiki's Introduction

Team-Wiki

A completely data driven wiki site

Build a single JSON file and that's it!

Team-wiki was designed so that it's easy to create, or generate new wiki pages.

Just add to the JSON file, and that's it.

JSON Documentation

title

Title is the title of the wiki.
If you are making a wiki about Food your title should probably be Food or Foods

theme

This is the color scheme of your wiki. The font color will automatically set based off of the theme.

primary

By default it's set to   #2196f3 #2196f3

secondary

By default it's set to   #FFFFFF #FFFFFF

home

Home is the landing page of your wiki site. The search bar searches through your list of pages, and will automatically navigate you to the page you have searched for.

logo

This is the url for the image you want to show up above the search bar on the home page.

footer

Not yet implemented

categories

Categories are sections, that you can put your pages under. Similar to how you would put your files in a folder if you wanted to organize it.

id

Each category needs a unique identifier, so that the pages know which category they belong to.

name

The name of your category.

showInDrawer

Whether or not you wish to show the category in the side drawer.

pages

These are the actual pages of your wiki site. You may have a page for Hot Dogs, or Porkchops.

id

Each page needs a unique identifier, so that the articles know which page they belong to.

category

This is the category Id that the page belongs to.

title

The title of your wiki page.

description

The description of your wiki page, this will show up as a subheader of the page.

style

Not Yet Implemented

articles

Articles are the content that you wish to be displayed inside of your wiki page.

id

The unique identifier of your article, these have no use as of right now. When widgets are implemented, they will be the unique identifier for widgets.

title

The title of your article, or a header for your content.

description

The actual content of your article, currently only accepts strings.

style

Not Yet Implemented

widgets

Not yet implemented

team-wiki's People

Contributors

archerscript 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.