Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/crowdin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
push:
paths:
- 'docs/**.md'
branches: [develop, master]
branches: [develop, main]

jobs:
crowdin:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Build & Test

on:
push:
branches: [master, main, develop]
branches: [main, develop]
pull_request:
branches: [master, main, develop]
branches: [main, develop]
workflow_dispatch:

jobs:
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
## [4.13.1](https://github.com/docsifyjs/docsify/compare/v4.13.0...v4.13.1) (2023-06-24)


### Bug Fixes

* enhancement of isExternal ([#2093](https://github.com/docsifyjs/docsify/issues/2093)) ([6a7d15b](https://github.com/docsifyjs/docsify/commit/6a7d15b1d5b93e19d3cf9a328cdbf5f1a166b5bd))
* fix cross-origin links in history router mode ([#1967](https://github.com/docsifyjs/docsify/issues/1967)) ([2312fee](https://github.com/docsifyjs/docsify/commit/2312feef459211a8bcdcbf9164a9ffe051609b70))
* genIndex error for search ([#1933](https://github.com/docsifyjs/docsify/issues/1933)) ([68d8735](https://github.com/docsifyjs/docsify/commit/68d873587c29d694ece466177984aa5fd739dd4b))



# [4.13.0](https://github.com/docsifyjs/docsify/compare/v4.12.4...v4.13.0) (2022-10-26)


Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ A large collection of showcase projects are included in [awesome-docsify](https:

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).
See [CONTRIBUTING.md](CONTRIBUTING.md).

## Backers

Expand All @@ -75,12 +75,9 @@ Thank you for supporting this project! ❤️ [[Become a sponsor](https://openco
## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>

## License

[MIT](LICENSE)

## Special Thanks

A preview of Docsify's PR and develop branch is <a href="https://vercel.com/?utm_source=docsifyjs&utm_campaign=oss" target="_blank">Powered by <img src="https://cdn.jsdelivr.net/gh/docsifyjs/docsify/docs/_media/vercel_logo.svg" alt="Vercel" width="133px"></a>
2 changes: 2 additions & 0 deletions build/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then

# test
npm run test
# update snapshot
npm run test:update:snapshot

# commit
git add -A
Expand Down
4 changes: 0 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase)

Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:

### Gold sponsors

[![](_images/Route4Me.png ':size=200')](https://route4me.com/ 'Best Route Planning and Route Optimization Software')

## Community

Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).
2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![logo](_media/icon.svg)

# docsify <small>4.13.0</small>
# docsify <small>4.13.1</small>

> A magical documentation site generator

Expand Down
Binary file removed docs/_images/Route4Me.png
Binary file not shown.
3 changes: 0 additions & 3 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,3 @@

- [English](/)
- [简体中文](/zh-cn/)
- [Deutsch](/de-de/)
- [Español](/es/)
- [Русский](/ru-ru/)
2 changes: 1 addition & 1 deletion docs/adding-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide

## Sidebar

In order to have a sidebar, you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/master/docs/_sidebar.md) for an example):
In order to have a sidebar, you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/main/docs/_sidebar.md) for an example):

First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#loadsidebar).

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ window.$docsify = {
'/foo/(.*)': '/bar/$1', // supports regexp
'/zh-cn/changelog': '/changelog',
'/changelog':
'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
'https://raw.githubusercontent.com/docsifyjs/docsify/main/CHANGELOG',

// You may need this if you use routerMode:'history'.
'/.*/_sidebar.md': '/_sidebar.md', // See #301
Expand Down Expand Up @@ -284,7 +284,7 @@ window.$docsify = {

// Or use the readme in your repo
homepage:
'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md',
'https://raw.githubusercontent.com/docsifyjs/docsify/main/README.md',
};
```

Expand Down
24 changes: 3 additions & 21 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
<script>
// Set html "lang" attribute based on URL
(function () {
const lang = location.hash.match(/#\/(de-de|es|ru-ru|zh-cn)\//);
const lang = location.hash.match(/#\/(zh-cn)\//);

if (lang) {
document.documentElement.setAttribute('lang', lang[1]);
Expand All @@ -100,14 +100,8 @@
'.*?/awesome':
'https://raw.githubusercontent.com/docsifyjs/awesome-docsify/master/README.md',
'.*?/changelog':
'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG.md',
'https://raw.githubusercontent.com/docsifyjs/docsify/main/CHANGELOG.md',
'/.*/_navbar.md': '/_navbar.md',
'/es/(.*)':
'https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1',
'/de-de/(.*)':
'https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1',
'/ru-ru/(.*)':
'https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1',
'/zh-cn/(.*)':
'https://cdn.jsdelivr.net/gh/docsifyjs/docs-zh@master/$1',
},
Expand All @@ -129,36 +123,24 @@
},
name: 'docsify',
nameLink: {
'/es/': '#/es/',
'/de-de/': '#/de-de/',
'/ru-ru/': '#/ru-ru/',
'/zh-cn/': '#/zh-cn/',
'/': '#/',
},
search: {
// insertAfter: '.app-name',
// insertBefore: '.sidebar-nav',
noData: {
'/es/': '¡No hay resultados!',
'/de-de/': 'Keine Ergebnisse!',
'/ru-ru/': 'Никаких результатов!',
'/zh-cn/': '没有结果!',
'/': 'No results!',
},
paths: 'auto',
placeholder: {
'/es/': 'Buscar',
'/de-de/': 'Suche',
'/ru-ru/': 'Поиск',
'/zh-cn/': '搜索',
'/': 'Search',
},
pathNamespaces: ['/es', '/de-de', '/ru-ru', '/zh-cn'],
pathNamespaces: ['/zh-cn'],
},
skipLink: {
'/es/': 'Saltar al contenido principal',
'/de-de/': 'Ga naar de hoofdinhoud',
'/ru-ru/': 'Перейти к основному содержанию',
'/zh-cn/': '跳到主要内容',
},
vueComponents: {
Expand Down
2 changes: 1 addition & 1 deletion docs/write-a-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ window.$docsify = {

hook.beforeEach(html => {
const url =
'https://github.com/docsifyjs/docsify/blob/master/docs/' +
'https://github.com/docsifyjs/docsify/blob/main/docs/' +
vm.route.file;
const editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n';

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docsify",
"version": "4.13.0",
"version": "4.13.1",
"description": "A magical documentation generator.",
"homepage": "https://docsify.js.org",
"repository": "github:docsifyjs/docsify",
Expand Down Expand Up @@ -115,6 +115,7 @@
"test:integration": "npm run test:jest -- --selectProjects integration",
"test:jest": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
"test:unit": "npm run test:jest -- --selectProjects unit",
"test:update:snapshot": "npm run test:jest -- --updateSnapshot",
"test": "run-s test:jest test:e2e",
"watch:css": "run-p 'build:css -- --watch' 'build:css:min -- --watch'",
"watch:js": "npm run build:js -- --watch"
Expand Down
4 changes: 2 additions & 2 deletions test/integration/__snapshots__/docs.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ exports[`Docs Site coverpage renders and is unchanged 1`] = `
<div class="mask"></div>
<div class="cover-main"><!-- markdownlint-disable first-line-h1 -->

<p><img src="http://127.0.0.1:4000/_media/icon.svg" data-origin="_media/icon.svg" alt="logo"></p><h1 id="docsify-4130" tabindex="-1"><a href="#/?id=docsify-4130" data-id="docsify-4130" class="anchor"><span>docsify <small>4.13.0</small></span></a></h1><blockquote>
<p><img src="http://127.0.0.1:4000/_media/icon.svg" data-origin="_media/icon.svg" alt="logo"></p><h1 id="docsify-4131" tabindex="-1"><a href="#/?id=docsify-4131" data-id="docsify-4131" class="anchor"><span>docsify <small>4.13.1</small></span></a></h1><blockquote>
<p>A magical documentation site generator</p></blockquote>
<ul><li>Simple and lightweight</li><li>No statically built HTML files</li><li>Multiple themes</li></ul><p><a href="#/?id=docsify" class="button primary">Get Started</a>
<a href="https://github.com/docsifyjs/docsify/" target="_blank" rel="noopener" class="button secondary">GitHub</a></p><!-- ![color](#f0f0f0) -->
Expand All @@ -17,7 +17,7 @@ exports[`Docs Site coverpage renders and is unchanged 1`] = `
exports[`Docs Site navbar renders and is unchanged 1`] = `
"<nav class="app-nav" aria-label="secondary"><!-- markdownlint-disable first-line-h1 -->

<ul><li><p>Translations</p><ul><li><a href="#/">English</a></li><li><a href="#/zh-cn/">简体中文</a></li><li><a href="#/de-de/">Deutsch</a></li><li><a href="#/es/">Español</a></li><li><a href="#/ru-ru/">Русский</a></li></ul></li></ul></nav>"
<ul><li><p>Translations</p><ul><li><a href="#/">English</a></li><li><a href="#/zh-cn/">简体中文</a></li></ul></li></ul></nav>"
`;

exports[`Docs Site sidebar renders and is unchanged 1`] = `
Expand Down