https://github.com/ablipan/doggy

(WIP) A documentation generator.
https://github.com/ablipan/doggy

Last synced: 3 days ago
JSON representation

(WIP) A documentation generator.

• Host: GitHub
• URL: https://github.com/ablipan/doggy
• Owner: ablipan
• Created: 2017-09-30T08:59:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-09T03:52:48.000Z (about 7 years ago)
• Last Synced: 2024-10-31T17:56:48.127Z (17 days ago)
• Language: JavaScript
• Size: 34.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Doggy

!! WIP, DO NOT USE !!

Make your IE8 compatible lib's documentation working on IE8 🙄.

Totally inspired by [docsify](https://github.com/QingWei-Li/docsify), some codes are copied from it right now 🤒. If you do not need IE8 compatible, just use the powerful [docsify](https://github.com/QingWei-Li/docsify).

# Quick start

### New index.html

```html

  

  Doggy demo

  

  

  

  



  window.$doggy = {

    basePath: '/example'

  }

```

### New `_sidebar.md` in the folder with `index.html`

```markdown

- Getting started

  - [Quick start](demo.md)

  - [BEM](BEM.md)

```

### Serve the folder

You can use [serve](https://github.com/zeit/serve)

## Dev

1. `npm i`

2. `npm run dev`

3. open `http://127.0.0.1:8080/example` in browser

## Tools

* [docsify](https://github.com/QingWei-Li/docsify)

* BEM

* Webpack@v1

* jQuery

* Flow

* ESLint

* Babel

* Stylus

* marked

* page.js

  

## Polyfill

* [es5-shim](https://github.com/es-shims/es5-shim) extends ES3的一些方法做扩展，比如String.trim,Array.forEach,Array.map等。

es5-sham则是对ES3做Object的一些ES5的属性方法扩展，如‘Object.create,Object.getPrototypeOf,Object.freeze’等等。

* [json3](https://github.com/bestiejs/json3) 在 IE7及一下的浏览器中实现 JSON 的 stringify 方法和 parse 方法

## Issues

* [ ] Table css

* [ ] Multi level side menu

* [ ] Router not working on ie8... Old browsers

  * [ ] Use params instead of hash on old browsers? like: xxx?page=demo.md&id=how-to-use-it

## TODO

* [ ] Demo block half screen

* [ ] nanocss

* [ ] Flow

* [ ] Speed up for modern browser