docsify

mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-01 19:50:32 +08:00

Migrated repository

Go to file

Joe Pea 4e8d6dffce chore: create .gitattributes（#2288） It is recommended by Prettier to use LF endings for all files including in Windows, and they officially recommend to set this option in .gitattributes file for consistency, and LF is the default in Prettier 2 or higher. The lack of this file bit me in another project whose build failed in Windows in GitHub Actions due to `prettier --check` failing in Windows with default LF mode. More info: https://github.com/prettier/prettier/issues/7825#issuecomment-602171740		2023-10-23 04:03:53 +08:00
.github	action: reduce dependabot frequency from weekly to monthly, get rid of email spam (#2289 )	2023-10-22 09:11:12 +08:00
.vscode	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
build	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
docs	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
src	chore: Fix typo in multiple file of docsify (#2284 )	2023-10-20 09:24:35 +08:00
test	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
.editorconfig	add editorconfig (tells editors which basic text format to use)	2020-05-22 01:29:36 -07:00
.eslintignore	refactor: delete the experimental and incomplete SSR feature	2023-06-25 12:03:44 -07:00
.eslintrc.cjs	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
.gitattributes	chore: create .gitattributes（#2288）	2023-10-23 04:03:53 +08:00
.gitignore	fix: Coverpage when content > viewport height (#1744 )	2022-02-03 16:03:34 -06:00
.gitpod.yml	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
.npmignore	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
.prettierignore	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
.prettierrc.json	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
babel.config.json	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
CHANGELOG.md	chore: Fix typo in multiple file of docsify (#2284 )	2023-10-20 09:24:35 +08:00
CONTRIBUTING.md	refactor: delete the experimental and incomplete SSR feature	2023-06-25 12:03:44 -07:00
Dockerfile	test:docker locally.	2021-12-10 01:55:30 +08:00
HISTORY.md	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
index.html	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
jest.config.js	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
LICENSE	Update LICENSE	2022-01-16 19:52:18 -08:00
package-lock.json	chore: bump @rollup/plugin-replace from 5.0.2 to 5.0.3 (#2258 )	2023-10-15 18:12:54 +08:00
package.json	chore: Fix typo in multiple file of docsify (#2284 )	2023-10-20 09:24:35 +08:00
playwright.config.js	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00
README.md	chore: sponsors list fix. (#2175 )	2023-08-14 15:02:32 +08:00
SECURITY.md	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
server.js	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2023-06-29 19:02:08 -07:00

README.md

A magical documentation site generator.

Gold Sponsor via Open Collective

Docsify turns one or more Markdown files into a Website, with no build process required.

Features

No statically built html files
Simple and lightweight
Smart full-text search plugin
Multiple themes
Useful plugin API
Support embedded files

Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use Docsify Template, review the quick start tutorial or jump right into a CodeSandbox example site with the button below.