Commit Graph
59 Commits
Author SHA1 Message Date
Joe Pea 00a87311b0 allow the el option to accept an HTMLElement instance
This aligns it with what the docs were already saying erroneously, plus
this is useful in cases when people have refs to an element already
(embedding Docsify in a custom element shadow root, or in a React
component that has a ref to the target element, etc).
2022-01-05 09:55:48 -08:00
Joe Peaand沈唁 760e0c7983 docs: update noCompileLinks documentation (#1666)
Co-authored-by: 沈唁 <52o@qq52o.cn>
2021-11-19 17:19:45 +08:00
2jun0and沈唁 57dc8a9238 docs: Update nameLink in configuration.md (#1653)
Like [this commit](https://github.com/docsifyjs/docsify/pull/1651), thie configuration.md page needs to be updated.

Co-authored-by: 沈唁 <52o@qq52o.cn>
2021-10-22 09:50:34 +08:00
John Jago 97806cb757 docs: improve English wording (Getting Started/Customization) (#1617)
While referencing the documentation, I noticed a few phrases that could
be changed to sound more natural. I tried to keep the original meanings.
2021-07-30 10:18:00 +08:00
Mark Battistella 6c13bdb7bd docs: Updated alias (#1511)
The expression in alias `(+*)` is invalid and a correct working method would be `(.*)`
2021-02-15 09:48:00 +08:00
John Hildenbiddle 7cf1e7c27a Update Vue-related descriptions and links 2020-11-19 15:42:51 -06:00
John Hildenbiddle 9a1935ac64 Add support for Vue shorthand directive syntax 2020-11-15 13:34:03 -06:00
John Hildenbiddle a10fcbd9a6 Update Vue-related descriptions 2020-11-12 17:25:48 -06:00
John Hildenbiddle 69efae3c4f Fix typos 2020-11-11 16:27:14 -06:00
John Hildenbiddle 727ee8fc6d Rename vueMountOptions to vueMounts 2020-11-11 16:24:50 -06:00
John Hildenbiddle 421ef1d442 Update docs 2020-11-10 23:24:21 -06:00
John Hildenbiddle 86dae610de Rename vueOptions to vueMountOptions 2020-10-21 13:14:07 -05:00
John Hildenbiddle 5a2dde1624 Update docs 2020-10-20 17:45:34 -05:00
Koy 0ef6aa8ab3 docs: add crossOriginLinks configurations details. (#1386) 2020-10-08 07:00:08 +08:00
Bharat Patodiand沈唁 1a64dc847f chore: grammatical changes (#1296)
* Make grammatical changes

Minor changes.
Solely for improving readability.

* Update changes

Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-07-26 14:49:02 +05:30
Joe Pea 809fda9591 Merge branch 'develop' into allow-config-function 2020-06-07 14:10:57 -07:00
Joe Pea 5a5b5aa932 update docs regarding configs as functions 2020-05-22 01:42:40 -07:00
Gabin Aureche 455f4c4a09 docs(configuration): mention active link pitfall for the homepage 2020-05-15 09:20:00 +02:00
Emerson Jair d5a7507af2 Fix typo on externalLinkRel
Also, add a link explaining why that can be a security issue.
2020-05-04 07:57:24 -03:00
Joe Pea b2e6123980 Update nameLink option docs (#1125) 2020-04-19 21:02:07 +05:30
Leonardo Rossi b53ea1e304 Adds option to specify an header height (#1045)
* Adds option to specify an header height

When using a template that has a sticky-header, clicking on the sidebar will
scroll the page under the header.

I added the option `headerHeight` (default = `0`) so that the content div will
be scrolled down that amount of pixels.

* updates documentation and renames variable
2020-03-09 14:19:31 +05:30
Anix b7547f151e feat: new option hideSidebar (#1026)
* feat: new option hideSidebar

* chore: removed the console logs

* chore: linting fixes

* chore: test fix
2020-02-20 22:19:31 +05:30
Anix a111df9980 chore: documented __colon__ tip (#1025) 2020-02-14 20:41:53 +05:30
Joe Pea 67a981b8d9 update docs for the name config option 2019-12-29 12:28:26 -08:00
cinwell.li 8416275e25 docs: about cache (#854) 2019-12-22 17:16:23 +05:30
Vaishak Kallore 11762cbb73 Merged upstream develop and resolved the conflict 2019-12-02 18:04:59 +05:30
Mt e61410a757 add new config cornerExternalLinkTarget for the corner link target
rm   CNAME

add CNAME

add repo test

back to the origin index.html

fix: the Git corner displayed bigger when the externalLinkTarget = ''

[update] a new independent config for corner link target attribute.

[update doc] add the `cornerExternalLinkTarget` config in the doc.
2019-12-02 18:10:42 +08:00
Vaishak Kallore 4769018e26 Added support for rel='noopener' 2019-09-06 11:13:40 +05:30
Sylvain Brocard 31654f12ec feat: allows relative path, fixed #590 2019-03-25 16:33:03 +01:00
Johannes Rappen 73a38c3878 chore: update german docs, fix links (#560)
* updated german links
* fixed links where `QingWei-Li` should've been `docsifyjs`
  * naturally excluded donate links and links to private projects like `vuep` unrelated to docsify

---

See commit for details. If you have a question, just ask.
2018-07-01 13:48:44 +08:00
Nik Sudan 7dcebe7544 docs: Correct default value for routerMode (#549)
This was `history` when it should have been set to `hash`. It also described the correct value in the example, which was misleading.

Please makes sure these boxes are checked before submitting your PR, thank you!

* [x] Make sure you are merging your commits to `master` branch.
* [x] Add some descriptions and refer relative issues for you PR.
* [x] DO NOT include files inside `lib` directory.
2018-06-25 21:17:02 +08:00
cinwell.li ee72dd05e5 feat: add logo option, #264 (#541) 2018-06-19 08:19:21 +08:00
cinwell.li 8352a1e489 refactor: build config (#408)
* refactor: build config

* chore: fix conflict

* fix: 404 page path
2018-03-03 22:51:27 +08:00
Romain Lenzotti 9b3b4454de feat(config): Add 404 page options. (#406)
This feature add the notFoundPage options to customize the default 404 page
with a markdown file. It also support the localisation.
2018-03-03 22:09:01 +08:00
Romain Lenzotti ecc0e04c70 feat(fetch): Add fallback languages configuration. (#402)
fallbackLanguages give the possibility to configure a list of languages which must used the default language when a page is missing in the requested language.
2018-03-01 22:37:30 +08:00
Jingjie Yang 杨竞颉 84f7b5c7c2 chore: typo (#392)
> Only coverpage is loaded when ~~When~~ visiting the home page.
2018-02-15 08:57:17 +08:00
qingwei.li cb900a68e5 docs: add requestHeaders and ext 2018-02-11 22:22:06 +08:00
qingwei.li 4bdcee2cb3 docs: add mutiple covers 2018-02-11 22:22:06 +08:00
qingwei.li bd7ee84241 docs: update config 2018-02-11 22:22:06 +08:00
ItsPugle 689d3ddeaf chore: Fixing default option for externalLinkTarget (#348) 2018-01-14 22:29:03 +08:00
qingwei.li 3af1641874 docs: update alias 2017-12-14 09:40:29 +08:00
cinwell.li 2e00f4c993 feat: ignore to compiled link, fixed #203 (#204)
* feat: ignore to compiled link, fixed #203

* feat: add noCompileLinks, fixed #203

* fix: remove test code
2017-07-10 22:38:26 +08:00
qingwei.li 7fb5ce6c84 docs: add alias 2017-07-10 22:23:09 +08:00
Kevin Leung d469442eae Update doc for external link target (#194) 2017-06-16 16:14:23 +08:00
qingwei.li 7e169ad154 docs(changelog): 4.1.0 2017-05-30 12:05:25 +08:00
qingwei.li 2d73285de5 feat: add externalLinkTarget, close #149 2017-05-16 23:09:41 +08:00
qingwei.li d2be5aecf8 feat: add docsify-updated, close #158 2017-05-16 23:03:22 +08:00
cinwell.li 9220523a40 feat(render): add mergeNavbar option, close #125, #124 (#145) 2017-04-09 12:10:37 +08:00
qingwei.li 8f11653b41 feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00
qingwei.li 3aef37a445 feat(emojify): add no-emoji option 2017-03-11 19:30:38 +08:00