diff --git a/README.md b/README.md index 371a983..d976d3e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

Backers on Open Collective Sponsors on Open Collective - Travis Status + Travis Status npm donate gitter @@ -28,9 +28,9 @@ ## Links - [Documentation](https://docsify.js.org) -- [CLI](https://github.com/QingWei-Li/docsify-cli) +- [CLI](https://github.com/docsifyjs/docsify-cli) - CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) -- [Awesome docsify](https://github.com/QingWei-Li/awesome-docsify) +- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify) - [Community chat](https://gitter.im/docsifyjs/Lobby) ## Features @@ -41,7 +41,7 @@ - Multiple themes - Useful plugin API - Compatible with IE10+ -- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo)) - Support embedded files ## Quick start @@ -52,7 +52,7 @@ Look at [this tutorial](https://docsify.js.org/#/quickstart) or [online demo](ht These projects are using docsify to generate their sites. Pull requests welcome :blush: -Move to [awesome-docsify](https://github.com/QingWei-Li/awesome-docsify) +Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify) ## Similar projects @@ -99,10 +99,10 @@ Support this project by becoming a sponsor. Your logo will show up here with a l ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - + ## License MIT -[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large) +[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large) diff --git a/docs/README.md b/docs/README.md index bb3abe2..a8fab02 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,11 +18,11 @@ See the [Quick start](quickstart.md) for more details. - Emoji support - Compatible with IE10+ -* Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +* Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo)) ## Examples -Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use. +Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to docsify in use. ## Donate diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 26f7c8e..5251ea1 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -8,5 +8,5 @@ * No statically built html files * Multiple themes -[GitHub](https://github.com/QingWei-Li/docsify/) +[GitHub](https://github.com/docsifyjs/docsify/) [Get Started](#docsify) diff --git a/docs/configuration.md b/docs/configuration.md index 768b5ef..830748f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,7 +5,7 @@ You can configure the `window.$docsify`. ```html ``` +oder auch: + ```html @@ -44,6 +50,6 @@ Alternativ kannst du auch die [komprimierten Dateien](#komprimierte-dateien) ver ## Andere CDN -- http://www.bootcdn.cn/docsify -- https://cdn.jsdelivr.net/npm/docsify/ -- https://cdnjs.com/libraries/docsify +- +- +- diff --git a/docs/de-de/configuration.md b/docs/de-de/configuration.md index 4fa9c94..da89bf0 100644 --- a/docs/de-de/configuration.md +++ b/docs/de-de/configuration.md @@ -1,11 +1,11 @@ # Einstellungen -You can configure the `window.$docsify`. +Du kannst Einstellungen für `window.$docsify` wie folgt ändern: ```html diff --git a/docs/de-de/more-pages.md b/docs/de-de/more-pages.md index 1cfc001..4474e32 100644 --- a/docs/de-de/more-pages.md +++ b/docs/de-de/more-pages.md @@ -1,6 +1,7 @@ # Noch mehr Seiten -Wenn du mehr Seiten für deine Dokumentation brauchst, so kannst du weitere Markdown Dateien in deinem **docsify** Ordner erstellen. Eine Datei namens `guide.md` ist dann über `/#/guide` erreichbar. +Wenn du mehr Seiten für deine Dokumentation brauchst, so kannst du weitere Markdown Dateien in deinem **docsify** Ordner erstellen. +Eine Datei namens `guide.md` ist dann über `/#/guide` erreichbar. Nehmen wir als Beispiel folgende Verzeichnisstruktur: @@ -25,7 +26,8 @@ docs/de-de/guide.md => http://domain.com/de-de/guide ## Seitenleiste mit Inhaltsverzeichnis anpassen -Als Standardeinstellung wird das Inhaltsverzeichnis in der Seitenleiste automatisch basierend auf vorhandenen Markdown Dateien generiert. Wenn du das seitliche Inhaltsverzeichnis anpassen willst, kannst du eine Datei namens `_sidebar.md` erstellen (vergleiche [das seitliche Inhaltsverzeichnis für diese Dokumentation](https://github.com/QingWei-Li/docsify/blob/master/docs/de-de/_sidebar.md) als Beispiel): +Als Standardeinstellung wird das Inhaltsverzeichnis in der Seitenleiste automatisch basierend auf vorhandenen Markdown Dateien generiert. +Wenn du das seitliche Inhaltsverzeichnis anpassen willst, kannst du eine Datei namens `_sidebar.md` erstellen (vergleiche [das seitliche Inhaltsverzeichnis für diese Dokumentation](https://github.com/docsifyjs/docsify/blob/master/docs/de-de/_sidebar.md) als Beispiel): Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](configuration.md#loadsidebar). @@ -53,7 +55,7 @@ Als Zweites erstellst du eine Datei namens `_sidebar.md`: `_sidebar.md` wird in jedem Verzeichnislevel geladen. Sollte das aktuelle Verzeichnis keine Datei namens `_sidebar.md` haben, so sucht **docsify** in den übergeordneten Ordnern. Wenn du z.B. im Moment im Verzeichnis `/guide/quick-start` bist, so wird `_sidebar.md` von der Datei `/guide/_sidebar.md` geladen. -You can specify `alias` to avoid unnecessary fallback. +Du kannst `alias` definieren, um einen überflüssigen fallback zu vermeiden. ```html ``` -## Ignoring Subheaders +## Ignorieren vun untergeordneten Überschriften -When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it. +Wenn `subMaxLevel` definiert ist, wird jede Überschrift in der Standardeinstellung zum Inhaltsverzeichnis hinzugefügt. +Wenn du bestimmte Überschriften ignorieren möchtest, füge ihnen **`{docsify-ignore}`** hinzu. ```markdown # Getting Started @@ -94,7 +97,7 @@ When `subMaxLevel` is set, each header is automatically added to the table of co This header won't appear in the sidebar table of contents. ``` -To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page. +Um alle Überschriften auf einer Seite zu ignorieren, füge der ersten Überschrift auf der Seite **`{docsify-ignore-all}`** hinzu. ```markdown # Getting Started {docsify-ignore-all} @@ -104,4 +107,4 @@ To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on This header won't appear in the sidebar table of contents. ``` -Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used. +Beide Variablen, sowohl **`{docsify-ignore}`** als auch **`{docsify-ignore-all}`**, werden auf der Seite nicht gerendert (angezeigt). diff --git a/docs/de-de/plugins.md b/docs/de-de/plugins.md index eb5e791..28caa56 100644 --- a/docs/de-de/plugins.md +++ b/docs/de-de/plugins.md @@ -96,31 +96,31 @@ Exclude the special image ![](image.png ':no-zoom') ``` -## Demo code with instant preview and jsfiddle integration +## Auf GitHub ändern -With this plugin, sample code can be rendered on the page instantly, so that the readers can see the preview immediately. -When readers expand the demo box, the source code and description are shown there. if they click the button `Try in Jsfiddle`, -`jsfiddle.net` will be open with the code of this sample, which allow readers to revise the code and try on their own. +Fügen deinen Seiten einen `Ändere diese Seite auf GitHub` Button hinzu. Zur Verfügung gestellt von [@njleonzhang](https://github.com/njleonzhang), siehe [njleonzhang/docsify-edit-on-github](https://github.com/njleonzhang/docsify-edit-on-github) -[Vue](https://njleonzhang.github.io/docsify-demo-box-vue/) and [React](https://njleonzhang.github.io/docsify-demo-box-react/) are both supported. +## Beispielcode mit direkter Vorschau und Integration mit jsfiddle -## Edit on github +Mit dieser Erweiterung kann Beispielcode auf einer Seite mit einer zugehörigen Vorschau direkt angezeigt werden. -Add `Edit on github` button on every pages. Provided by [@njleonzhang](https://github.com/njleonzhang), check [document](https://github.com/njleonzhang/docsify-edit-on-github) +Beim Erweitern des Demobereichs werden Quellcode und Beschreibungen mit einem `Try in Jsfiddle` Button dort angezeigt, über den man den Code selbst anpassen und ausprobieren kann. -## Copy to Clipboard +[Vue](https://njleonzhang.github.io/docsify-demo-box-vue/) und [React](https://njleonzhang.github.io/docsify-demo-box-react/) werden beide unterstützt. -Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by [@jperasmus](https://github.com/jperasmus) +## Kopiere in Zwischenablage + +Füge den Quellcode-Blöcken auf deinen Seiten einen einfachen `Click to copy` Button hinzu. Zur Verfügung gestellt von [@jperasmus](https://github.com/jperasmus) ```html ``` -See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details. +Siehe auch [jperasmus/docsify-copy-code](https://github.com/jperasmus/docsify-copy-code#readme). ## Disqus -Disqus comments. https://disqus.com/ +[Disqus](https://disqus.com) Kommentare: ```html ``` -## Pagination +## Seitenumbrüche -Pagination for docsify. By [@imyelo](https://github.com/imyelo) +Seitenumbrüche, zur Verfügung gestellt von [@imyelo](https://github.com/imyelo): ```html ``` + +## codefund + +Eine [Erweiterung](https://github.com/njleonzhang/docsify-plugin-codefund) für [codefund.io](https://codefund.io/). + +> codefund war vorher codesponsor + +``` + + +window.$docsify = { + plugins: [ + DocsifyCodefund.create('xxxx-xxx-xxx') // change to your codefund id + ] +} +``` diff --git a/docs/de-de/quickstart.md b/docs/de-de/quickstart.md index c68f67c..779199d 100644 --- a/docs/de-de/quickstart.md +++ b/docs/de-de/quickstart.md @@ -32,7 +32,7 @@ Du kannst einen lokalen Server mit dem Befehl `docsify serve` laufen lassen, und docsify serve docs ``` -?> Für weitere Informationen hinsichtlich der Verwendung von `docsify-cli`, siehe [docsify-cli Dokumentation](https://github.com/QingWei-Li/docsify-cli). +?> Für weitere Informationen hinsichtlich der Verwendung von `docsify-cli`, siehe [docsify-cli Dokumentation](https://github.com/docsifyjs/docsify-cli). ## Manuelle Inbetriebnahme diff --git a/docs/de-de/ssr.md b/docs/de-de/ssr.md index b7849b3..35a8197 100644 --- a/docs/de-de/ssr.md +++ b/docs/de-de/ssr.md @@ -1,22 +1,22 @@ # Server-Side Rendering -See https://docsify.now.sh +* siehe +* Quellcode siehe -Repo in https://github.com/QingWei-Li/docsify-ssr-demo +## Warum SSR? -## Why SSR? -- Better SEO -- Feeling cool +- Bessere SEO +- Damit du dich cool fühlst! -## Quick start +## Schnellstart -Install `now` and `docsify-cli` in your project. +Installiere `now` und `docsify-cli` in deinem Projekt. ```bash npm i now docsify-cli -D ``` -Edit `package.json`. If the documentation in `./docs` subdirectory. +Ändere `package.json`. Im folgenden Beispiel ist die Dokumentation im `./docs` Verzeichnis: ```json { @@ -30,7 +30,7 @@ Edit `package.json`. If the documentation in `./docs` subdirectory. ], "docsify": { "config": { - "basePath": 'https://docsify.js.org/', + "basePath": "https://docsify.js.org/", "loadSidebar": true, "loadNavbar": true, "coverpage": true, @@ -40,9 +40,9 @@ Edit `package.json`. If the documentation in `./docs` subdirectory. } ``` -!> The `basePath` just like webpack `publicPath`. We can use local or remote files. +!> Für `basePath` ist dies der gleiche wie bei webpack `publicPath`. Unterstützt werden lokale oder remote Dateien. -We can preview in the local to see if it works. +Wir können lokale Dateien verwenden, um zu sehen, ob es funktioniert. ```bash npm start @@ -50,17 +50,17 @@ npm start # open http://localhost:4000 ``` -Publish it! +Veröffentliche sie! ```bash now -p ``` -Now, You have a support for SSR the docs site. +Damit hast du SSR Unterstützung für deine Dokumentation. -## Custom template +## Eigene Vorlagen -You can provide a templte for entire page's HTML. such as +Du kannst eine Vorlage für deine gesammte Seite wie folgt erstellen: ```html @@ -83,13 +83,14 @@ You can provide a templte for entire page's HTML. such as ``` -The template should contain these comments for rendered app content. +Die Vorlage sollte folgende Kommentare für die Anzeige von Inhalten enthalten: + - `` - `` -## Configuration +## Einstellungen -You can configure it in a special config file, or `package.json`. +Du kannst die Einstellungen in einer speziellen Datei oder in `package.json` vornehmen: ```js module.exports = { @@ -100,9 +101,9 @@ module.exports = { } ``` -## Deploy for your VPS +## Deploy für deinen VPS -You can run `docsify start` directly on your Node server, or write your own server app with `docsify-server-renderer`. +Führe `docsify start` direkt auf deinem Node Server aus, oder schreibe deine eigene Server app mit `docsify-server-renderer`: ```js var Renderer = require('docsify-server-renderer') @@ -113,7 +114,7 @@ var renderer = new Renderer({ template: readFileSync('./docs/index.template.html', 'utf-8')., config: { name: 'docsify', - repo: 'qingwei-li/docsify' + repo: 'docsifyjs/docsify' } }) diff --git a/docs/de-de/themes.md b/docs/de-de/themes.md index e16242f..13a801c 100644 --- a/docs/de-de/themes.md +++ b/docs/de-de/themes.md @@ -20,7 +20,7 @@ Es gibt im Moment vier Themes zur Auswahl, ähnlich wie die Webseiten von [Vue]( ``` -Solltest du weitere Themes erstellen, kannst du sie gerne der Allgemeinheit mit einem [pull request](https://github.com/QingWei-Li/docsify/pulls) zur Verfügung stellen. +Solltest du weitere Themes erstellen, kannst du sie gerne der Allgemeinheit mit einem [pull request](https://github.com/docsifyjs/docsify/pulls) zur Verfügung stellen. #### Klicke hier für eine Vorschau @@ -57,6 +57,6 @@ Solltest du weitere Themes erstellen, kannst du sie gerne der Allgemeinheit mit -## Other themes +## Andere themes -- [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/#/) A delightfully simple theme system for docsify. +- [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/#/) Ein erfreulicherweise einfaches theme system für docsify. diff --git a/docs/de-de/write-a-plugin.md b/docs/de-de/write-a-plugin.md index b852ff0..260e8b8 100644 --- a/docs/de-de/write-a-plugin.md +++ b/docs/de-de/write-a-plugin.md @@ -59,7 +59,7 @@ window.$docsify = { '

', '' ].join('') @@ -79,7 +79,7 @@ window.$docsify = { plugins: [ function(hook, vm) { hook.beforeEach(function (html) { - var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file + var url = 'https://github.com/docsifyjs/docsify/blob/master/docs' + vm.route.file var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n' return editHtml @@ -91,4 +91,4 @@ window.$docsify = { } ] } -``` \ No newline at end of file +``` diff --git a/docs/index.html b/docs/index.html index 4d89784..17e7ab7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,8 +27,8 @@ - \ No newline at end of file + diff --git a/package.json b/package.json index 3bb1760..33085fe 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/QingWei-Li/docsify.git" + "url": "git+https://github.com/docsifyjs/docsify.git" }, "main": "lib/docsify.js", "unpkg": "lib/docsify.min.js", diff --git a/packages/docsify-server-renderer/README.md b/packages/docsify-server-renderer/README.md index a971436..08b99b9 100644 --- a/packages/docsify-server-renderer/README.md +++ b/packages/docsify-server-renderer/README.md @@ -17,7 +17,7 @@ var renderer = new Renderer({ template: readFileSync('./docs/index.template.html', 'utf-8')., config: { name: 'docsify', - repo: 'qingwei-li/docsify' + repo: 'docsifyjs/docsify' } }) diff --git a/packages/docsify-server-renderer/package.json b/packages/docsify-server-renderer/package.json index 0bfc665..de152db 100644 --- a/packages/docsify-server-renderer/package.json +++ b/packages/docsify-server-renderer/package.json @@ -9,7 +9,7 @@ }, "homepage": "https://docsify.js.org", "license": "MIT", - "repository": "QingWei-Li/docsify", + "repository": "docsifyjs/docsify", "main": "build.js", "scripts": { "test": "echo 'hello'" diff --git a/server.js b/server.js index 7275431..785e457 100644 --- a/server.js +++ b/server.js @@ -22,7 +22,7 @@ if (isSSR) { `, config: { name: 'docsify', - repo: 'qingwei-li/docsify', + repo: 'docsifyjs/docsify', basePath: 'https://docsify.js.org/', loadNavbar: true, loadSidebar: true, @@ -32,7 +32,7 @@ if (isSSR) { '/de-de/changelog': '/changelog', '/zh-cn/changelog': '/changelog', '/changelog': - 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG' + 'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG' } }, path: './'