Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.0 #81

Merged
merged 25 commits into from
Feb 19, 2017
Merged

3.0 #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
b9224ce
refactor(core): adjust directory structure:
QingWei-Li Feb 16, 2017
bdbedd2
refactor(core): add render
QingWei-Li Feb 17, 2017
b1c676c
refactor(core): add router
QingWei-Li Feb 18, 2017
8090ef9
refactor(core): and markdown compiler
QingWei-Li Feb 18, 2017
1143de2
refactor(core): and sidebar event
QingWei-Li Feb 18, 2017
1de67af
refactor(core): and cover
QingWei-Li Feb 18, 2017
a999a0c
refactor(core): add scroll event
QingWei-Li Feb 18, 2017
e566d5a
refactor(core): fix route path
QingWei-Li Feb 18, 2017
d315824
docs: update
QingWei-Li Feb 18, 2017
4b1494d
feat(render): add auto header
QingWei-Li Feb 18, 2017
6b80b2a
docs: add autoHeader
QingWei-Li Feb 18, 2017
925b64f
fix(compiler): link
QingWei-Li Feb 18, 2017
145d012
docs: move changelog to history
QingWei-Li Feb 18, 2017
35deb9c
docs: add executeScript demo
QingWei-Li Feb 18, 2017
ee77deb
fix(render): support html file
QingWei-Li Feb 18, 2017
1b479cb
docs(markdown): update markdown config
QingWei-Li Feb 18, 2017
55f255d
feat(themes): add loading info
QingWei-Li Feb 19, 2017
81cf3db
refactor(plugins): update search plugin
QingWei-Li Feb 19, 2017
be01017
feat(search): Localization for search placeholder, close #80
QingWei-Li Feb 19, 2017
a0e4560
docs(plugin): add search doc
QingWei-Li Feb 19, 2017
27366f9
fix(search): fix default config
QingWei-Li Feb 19, 2017
db446f1
fix(search): escape html
QingWei-Li Feb 19, 2017
b607df8
fix(search) ignore empty link
QingWei-Li Feb 19, 2017
ffebe07
feat(front-matter): add front matter[WIP]
QingWei-Li Feb 19, 2017
7c66d0a
docs: add changeog
QingWei-Li Feb 19, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"browser": true
},
"globals": {
"Docsify": true,
"$docsify": true
}
}
104 changes: 11 additions & 93 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,15 @@
### 2.4.3

> 2017-02-15
3.0.0 / 2017-02-19
==================

#### Bug fixes
* fix emoji replacing error (#76)

### 2.4.2

> 2017-02-14

#### Bug fixes
- fix(index): load file path error


### 2.4.1

> 2017-02-13

#### Bug fixes
- fix(index): cover page

### 2.4.0

> 2017-02-13
#### Breaking change
- Not support IE9
- The route becomes: `/#/page?id=slug`. The previous route will be redirected

#### Features

- feat(hook): add `doneEach`


### 2.3.0

> 2017-02-13

#### Features

- feat(src): add alias feature
- docs: update all documents
- feat(src): dynamic title
- feat(hook): support custom plugin
- feat(themes): add dark theme

#### Bug fixes
- fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
- fix: sidebar style
- fix(render): fix render link

### 2.2.1

> 2017-02-11

#### Bug fixes
- fix(search): crash when not content, fixed #68
- fix(event): scroll active sidebar
- fix(search): not work in mobile

### 2.2.0

#### Features
- Add `Google Analytics` plugin.
```html
<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
```

### 2.1.0
#### Features
- Add search plugin
```html
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
```

#### Bug fixes
- fix sidebar style

### 2.0.3
#### Bug fixes
- fix: rendering emojis
- fix: css var polyfill

### 2.0.2

#### Bug fixes
- fix button style in cover page.

### 2.0.1
#### Bug fixes
- border style.

### 2.0.0
#### Features
- Customize the theme color

#### Break change
- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
- Faster rendering
- Clearer source code
- More powerful API
- Auto header for each page [#78](https://github.com/QingWei-Li/docsify/issues/78)
- Localization for search plugin [#80](https://github.com/QingWei-Li/docsify/issues/80)
- Execute the script in markdown (see `executeScript`)
99 changes: 99 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,102 @@
### 2.4.3

> 2017-02-15

#### Bug fixes
* fix emoji replacing error (#76)

### 2.4.2

> 2017-02-14

#### Bug fixes
- fix(index): load file path error


### 2.4.1

> 2017-02-13

#### Bug fixes
- fix(index): cover page

### 2.4.0

> 2017-02-13

#### Features

- feat(hook): add `doneEach`


### 2.3.0

> 2017-02-13

#### Features

- feat(src): add alias feature
- docs: update all documents
- feat(src): dynamic title
- feat(hook): support custom plugin
- feat(themes): add dark theme

#### Bug fixes
- fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
- fix: sidebar style
- fix(render): fix render link

### 2.2.1

> 2017-02-11

#### Bug fixes
- fix(search): crash when not content, fixed #68
- fix(event): scroll active sidebar
- fix(search): not work in mobile

### 2.2.0

#### Features
- Add `Google Analytics` plugin.
```html
<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
```

### 2.1.0
#### Features
- Add search plugin
```html
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
```

#### Bug fixes
- fix sidebar style

### 2.0.3
#### Bug fixes
- fix: rendering emojis
- fix: css var polyfill

### 2.0.2

#### Bug fixes
- fix button style in cover page.

### 2.0.1
#### Bug fixes
- border style.

### 2.0.0
#### Features
- Customize the theme color

#### Break change
- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs


### 1.10.5
#### Bug fixes
- fix initialize the Vue instance
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE9+
- Compatible with IE10+

## Quick start
Create a `index.html`.
Expand Down
62 changes: 32 additions & 30 deletions build/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ var build = function (opts) {
rollup
.rollup({
entry: 'src/' + opts.entry,
plugins: [buble()].concat(opts.plugins || [])
plugins: [buble(), commonjs(), nodeResolve()].concat(opts.plugins || [])
})
.then(function (bundle) {
var dest = 'lib/' + (opts.output || opts.entry)
Expand All @@ -27,34 +27,36 @@ var build = function (opts) {
}

build({
entry: 'index.js',
output: 'docsify.js',
plugins: [commonjs(), nodeResolve()]
entry: 'core/index.js',
output: 'docsify.js'
})
isProd && build({
entry: 'index.js',
output: 'docsify.min.js',
plugins: [commonjs(), nodeResolve(), uglify()]
})
build({
entry: 'plugins/search.js',
output: 'plugins/search.js',
moduleName: 'D.Search'
})
isProd && build({
entry: 'plugins/search.js',
output: 'plugins/search.min.js',
moduleName: 'D.Search',
plugins: [uglify()]
})
build({
entry: 'plugins/ga.js',
output: 'plugins/ga.js',
moduleName: 'D.GA'
})
isProd && build({
entry: 'plugins/ga.js',
output: 'plugins/ga.min.js',
moduleName: 'D.GA',
plugins: [uglify()]

var plugins = [
{ name: 'search', entry: 'search/index.js', moduleName: 'Search' },
{ name: 'ga', entry: 'ga.js', moduleName: 'GA' }
// { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' }
]

plugins.forEach(item => {
build({
entry: 'plugins/' + item.entry,
output: 'plugins/' + item.name + '.js',
moduleName: 'D.' + item.moduleName
})
})

if (isProd) {
build({
entry: 'core/index.js',
output: 'docsify.min.js',
plugins: [uglify()]
})
plugins.forEach(item => {
build({
entry: 'plugins/' + item.entry,
output: 'plugins/' + item.name + '.min.js',
moduleName: 'D.' + item.moduleName,
plugins: [uglify()]
})
})
}
15 changes: 8 additions & 7 deletions dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
<meta charset="UTF-8">
<title>docsify</title>
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="/themes/vue.css">
<link rel="stylesheet" href="/themes/vue.css" title="vue">
<link rel="stylesheet" href="/themes/dark.css" title="dark" disabled>
<link rel="stylesheet" href="/themes/buble.css" title="buble" disabled>
</head>
<body>
<nav>
<nav data-cloak>
<a href="#/">EN</a>
<a href="#/zh-cn/">中文</a>
</nav>
Expand All @@ -19,16 +21,15 @@
'/zh-cn/changelog': '/changelog',
'/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
},
search: {
maxAge: 0
}
executeScript: true
}
</script>
<script
src="/lib/docsify.js"
data-name="docsify"
data-name="sdfsdf"
data-name-link="//www.baidu.com"
data-base-path="/docs/"
data-load-sidebar
data-sub-max-level="2"
data-base-path="docs/"
data-auto2top></script>
</html>
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See the [Quick start](/quickstart) for more details.
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE9+
- Compatible with IE10+

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Custom navbar](/custom-navbar)
- [Cover page](/cover)

- Configuration
- Customization
- [Configuration](/configuration)
- [Themes](/themes)
- [Using plugins](/plugins)
Expand Down
Loading