mirror of
https://github.com/wahyd4/docsify.git
synced 2026-08-09 21:36:10 +10:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f7779b01d9 | ||
|
|
1c935b2fd7 | ||
|
|
114955558e | ||
|
|
847cf3b656 | ||
|
|
356b937d44 |
@@ -1,3 +1,7 @@
|
||||
## 1.5.1
|
||||
### Bug fixes
|
||||
- Remove HTML tag when handling slug
|
||||
|
||||
## 1.5.0
|
||||
|
||||
### Bug fixes
|
||||
|
||||
+7
-7
@@ -33,7 +33,7 @@ Create `README.md` as the main page
|
||||
```
|
||||
|
||||
### Deploy!
|
||||
Push and open the **GitHub Pages** feature
|
||||
Push code and activate **GitHub Pages** via your repo's settings
|
||||

|
||||
|
||||
## CLI
|
||||
@@ -98,7 +98,7 @@ Code in `index.html`
|
||||
|
||||
### Cover Page
|
||||
|
||||
Generate a cover page through with markdown. Create a `_coverpage.md` and set `data-coverpage` in script tag.
|
||||
Generate a cover page with markdown. Create a `_coverpage.md` and set `data-coverpage` in the script tag.
|
||||
|
||||
```markdown
|
||||

|
||||
@@ -117,7 +117,7 @@ Generate a cover page through with markdown. Create a `_coverpage.md` and set `d
|
||||
```
|
||||
|
||||
#### Custom background
|
||||
Currently the background of cover page is generated randomly. We can customize the background, just using the syntax to add image.
|
||||
Currently the background of the cover page is generated randomly. We can customize the background color, or add a background image.
|
||||
|
||||
```markdown
|
||||
# docsify <small>1.2.0</small>
|
||||
@@ -135,7 +135,7 @@ Currently the background of cover page is generated randomly. We can customize t
|
||||
|
||||
### Markdown parser
|
||||
|
||||
Docsify uses [marked](https://github.com/chjj/marked) to parse markdown, we can configure it
|
||||
Docsify uses [marked](https://github.com/chjj/marked) to parse markdown. We can configure it
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
@@ -145,7 +145,7 @@ window.$docsify = {
|
||||
}
|
||||
```
|
||||
|
||||
And can even be completely customized
|
||||
And it can even be customized
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
@@ -159,7 +159,7 @@ window.$docsify = {
|
||||
|
||||
## Options
|
||||
|
||||
You can add configuration by script tag attributes or `window.$docsify`.
|
||||
You can add configurations in the script tag attributes or with `window.$docsify`.
|
||||
|
||||
### repo
|
||||
Display the [GitHub Corner](http://tholman.com/github-corners/) widget.
|
||||
@@ -247,7 +247,7 @@ window.$docsify = {
|
||||
|
||||
### load-sidebar
|
||||
|
||||
Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file isn't exist, sidebar will appear as a TOC.
|
||||
Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file doesn't exist, the sidebar will appear as a TOC.
|
||||
** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`**
|
||||
|
||||
```html
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||

|
||||
|
||||
# docsify <small>1.5.0</small>
|
||||
# docsify <small>1.5.1</small>
|
||||
|
||||
> A magical documentation site generator.
|
||||
|
||||
|
||||
@@ -125,6 +125,7 @@ function slugify (string) {
|
||||
if (!maintainCase) { string = string.toLowerCase(); }
|
||||
|
||||
var slug = string.trim()
|
||||
.replace(/<[^>\d]+>/g, '')
|
||||
.replace(re, '')
|
||||
.replace(/\s/g, replacement);
|
||||
var occurrences = slugify.occurrences[slug];
|
||||
|
||||
Vendored
+2
-2
File diff suppressed because one or more lines are too long
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "docsify",
|
||||
"version": "1.5.0",
|
||||
"version": "1.5.1",
|
||||
"description": "A magical documentation generator.",
|
||||
"main": "lib/docsify.js",
|
||||
"files": [
|
||||
|
||||
@@ -117,6 +117,7 @@ export function slugify (string) {
|
||||
if (!maintainCase) string = string.toLowerCase()
|
||||
|
||||
let slug = string.trim()
|
||||
.replace(/<[^>\d]+>/g, '')
|
||||
.replace(re, '')
|
||||
.replace(/\s/g, replacement)
|
||||
let occurrences = slugify.occurrences[slug]
|
||||
|
||||
Reference in New Issue
Block a user