docsify

mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00

Go to file

* chore: add missing Vue support for Vercel builds

* refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify

Also some small tweaks:

- move initGlobalAPI out of Docsify.js to start to encapsulate Docsify
- move ajax to utils folder
- fix some type definitions and improve content in some JSDoc comments
- use concise class field syntax
- consolidate duplicate docsify-ignore comment removal code

This handles a task in [Simplify and modernize Docsify](https://github.com/docsifyjs/docsify/issues/2104), as well as works towards [Encapsulating Docsify](https://github.com/docsifyjs/docsify/issues/2135).

* chore: add prettier code format check to our lint script, and add a prettier script for manually formatting the whole code base

* chore: update issue/pr templates

* chore: apply our format to the whole code base


---------

Co-authored-by: Koy <koy@ko8e24.top>
Co-authored-by: i544693 <369491420@qq.com>

2023-08-09 17:53:30 +08:00

.github

Ensure code format (#2138 )

2023-08-09 17:53:30 +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

Ensure code format (#2138 )

2023-08-09 17:53:30 +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

.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: add changelog v4.13.0

2022-10-26 21:50:32 +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 tough-cookie from 4.1.2 to 4.1.3 (#2121 )

2023-07-18 07:27:54 +08:00

package.json

Ensure code format (#2138 )

2023-08-09 17:53:30 +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

Ensure code format (#2138 )

2023-08-09 17:53:30 +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.