Giter Club home page Giter Club logo

docsify's Introduction

docsify's People

Contributors

listingslab avatar noobie2019 avatar weizang-75 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

docsify's Issues

Menu > Expand/Contract All

Cut & Paste

  • branch feature/sharky-drivebys

Toggle button which switches on or off the expansion panels in the Navigation component
it's going to need some kind of redux trigger/flag mechanism

EPIC > Menu Component

EPIC

Menu & Navigation

.jsx component which wraps the entire Menu/Navigation concept

Requires

  • A parser for structure
  • a list system the parsed results can slip back into
  • a routed solution to trigger the rendering of the correct content

How to create a story

Please create a markdown page called md/080_stories.md which describes how to write a good story because

Everything starts with a story, so first thing it to go to GitHub and create one. In the GitHub world it's called and Issue, which makes it sound like a bug, but bugs are a type of issue, not the other way around. Basic rule of thumb is; If you can write a good story, you will get a good outcome

New Doc > Open Source Management

headerOSM

OSM or Open Source Management is a methodology based on sound Agile concepts

Cut & Paste

  • branch feature/17_open-source-management

Routing Solution

Cut & Paste

  • branch feature/18_routing_solution

Requirement

The app works by asynchronously loading markdown files defined in config.json. The MarkDown is then rendered as HTML using the component src/components/Markdown.jsx

The Routing Solution should be created here src/appRouter.js

we also want a new action called goRoute It needs to;

  • Replace with the goTo action
  • Clear the loaded redux markdown when run
  • start loading new markdown
  • show a loader
  • handle error

Revamp PWA from @localify

the PWA in the /localify repo is a good place to bootstrap a clean PWA for docsify

  • Do the switch
  • fix the theme
  • edit the config file
  • read the config file
  • create menu
  • route to md pages
  • render markdown

New Doc > Git multiple branches

  • title Working with multiple Git branches
  • slug /agile/git/working-with-multiple-branches
  • file 010_working-with-multiple-branches.md
  • branch feature/010_working-with-multiple-branches

Let's say you are in the middle of doing something on the branch feature/branch1 and you get a new request for something which needs to take priority. How do you successfully shelve the first branch and deliver the new feature?

MarkDown Render Component

.jsx file which takes an object which looks like the json below and renders it using the correct library so it looks noice

{
    title: "A Page Title",
    icon: "icon.svg",
    markdown: '"## Markdown String',
    ...etc,
}

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.