visualifyjs 2.5.3-2.dev → 3.0.0

package/docs/docs/configuration.md

@@ -1,121 +1,121 @@
-# Configuration
-
-You can configure Visualify by defining `window.$visualify` or `$visualify` as
-an object:
-
-```js
-<script>
-window.$visualify = {
-    mode: 'pages',
-    // ...
-}
-</script>
-```
-
-Or you can initialize `$visualify` as a **Chart Module**:
-
-```js
-<script>
-$visualify = {
-    mode: 'charts',
-}
-
-new $visualify.Recharts({...}).mount('#chart')
-new $visualify.LiveEditor({...}).mount('#ex11');
-</script>
-```
-
-## el
-
--   Type: `String`
--   Default: `'#root'`
-
-The DOM element to be mounted on initialization. It can be a CSS selector string
-or an actual
-[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement).
-
-```js
-window.$visualify = {
-  el: '#root',
-};
-```
-
-## mode
-
--   Type: `String`
--   Default: `'pages'`
--   Options: `'pages'`, `'charts'`
-
-The mode of Visualify. If you want to use Visualify as a chart module, you can
-set `mode` to `'charts'`.
-
-```js
-window.$visualify = {
-  mode: 'charts',
-};
-```
-
-## theme
-
--   Type: `String`
--   Default: `'modern'`
--   Options: `'modern'`, `'classic'`
-
-The theme of Visualify. The default theme is `'modern'`. Themes usually make
-changes to the layout and components of the page. Built-in different themes
-provide different typesetting and functions, please choose different themes
-according to different needs, you can also replace a single css to change the
-style.
-
-```js
-window.$visualify = {
-  theme: 'modern',
-};
-```
-
-For more themes, please refer to [Themes](themes.md)
-
-## homepage
-
--   Type: `String`
--   Default: `'home.json'`
-
-The `home.json` in your docs folder will be treated as the homepage for your
-website, but sometimes you may need to serve another file as your homepage.
-
-```js
-window.$visualify = {
-    homepage: 'home',
-
-    // Or use the json in your repo
-    homepage: 'https://raw.githubusercontent.com/leolihao/visualify/master/docs/home.json',
-}
-```
-
-## repo
-
--   Type: `String`
-
-Configure the repository url, or a string of `username/repo`, to add the
-[GitHub Corner](http://tholman.com/github-corners/) widget in the top right
-corner of the site.
-
-```js
-window.$docsify = {
-  repo: 'https://github.com/visualify',
-};
-```
-
-## alias
-
--   Type: `Object`
-
-Set the route alias. You can freely manage `routing` rules. Supports `RegExp`.
-
-```js
-window.$visualify = {
-  alias: {
-    '/docsify': 'https://docsify.js.org/#/configuration?id=alias',
-  },
-};
-```
+# Configuration
+
+You can configure Visualify by defining `window.$visualify` or `$visualify` as
+an object:
+
+```js
+<script>
+window.$visualify = {
+    mode: 'pages',
+    // ...
+}
+</script>
+```
+
+Or you can initialize `$visualify` as a **Chart Module**:
+
+```js
+<script>
+$visualify = {
+    mode: 'charts',
+}
+
+new $visualify.Recharts({...}).mount('#chart')
+new $visualify.LiveEditor({...}).mount('#ex11');
+</script>
+```
+
+## el
+
+-   Type: `String`
+-   Default: `'#root'`
+
+The DOM element to be mounted on initialization. It can be a CSS selector string
+or an actual
+[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement).
+
+```js
+window.$visualify = {
+  el: '#root',
+};
+```
+
+## mode
+
+-   Type: `String`
+-   Default: `'pages'`
+-   Options: `'pages'`, `'charts'`
+
+The mode of Visualify. If you want to use Visualify as a chart module, you can
+set `mode` to `'charts'`.
+
+```js
+window.$visualify = {
+  mode: 'charts',
+};
+```
+
+## theme
+
+-   Type: `String`
+-   Default: `'modern'`
+-   Options: `'modern'`, `'classic'`
+
+The theme of Visualify. The default theme is `'modern'`. Themes usually make
+changes to the layout and components of the page. Built-in different themes
+provide different typesetting and functions, please choose different themes
+according to different needs, you can also replace a single css to change the
+style.
+
+```js
+window.$visualify = {
+  theme: 'modern',
+};
+```
+
+For more themes, please refer to [Themes](themes.md)
+
+## homepage
+
+-   Type: `String`
+-   Default: `'home.json'`
+
+The `home.json` in your docs folder will be treated as the homepage for your
+website, but sometimes you may need to serve another file as your homepage.
+
+```js
+window.$visualify = {
+    homepage: 'home',
+
+    // Or use the json in your repo
+    homepage: 'https://raw.githubusercontent.com/leolihao/visualify/master/docs/home.json',
+}
+```
+
+## repo
+
+-   Type: `String`
+
+Configure the repository url, or a string of `username/repo`, to add the
+[GitHub Corner](http://tholman.com/github-corners/) widget in the top right
+corner of the site.
+
+```js
+window.$docsify = {
+  repo: 'https://github.com/visualify',
+};
+```
+
+## alias
+
+-   Type: `Object`
+
+Set the route alias. You can freely manage `routing` rules. Supports `RegExp`.
+
+```js
+window.$visualify = {
+  alias: {
+    '/docsify': 'https://docsify.js.org/#/configuration?id=alias',
+  },
+};
+```

package/docs/docs/deploy.md

@@ -1,31 +1,31 @@
-# Deploy
-
-## On Your Local Machine
-
-You can deploy Visualify on your local machine by running a simple HTTP server.
-For example, you can use the `http-server` package from npm:
-
-```bash
-npm install -g http-server
-http-server ./docs
-```
-
-Then open your browser and navigate to `http://localhost:8080`.
-
-## On GitHub Pages
-
-There are three places to populate your docs for your GitHub repository:
-
--   `docs/` folder
--   main branch
--   gh-pages branch
-
-It is recommended that you save your files to the `./docs` subfolder of the
-`main` branch of your repository. Then select `main branch /docs folder` as your
-GitHub Pages source in your repository's settings page.
-
-![GitHub Pages](./static/_images/deploy-github-pages.png)
-
-!> You can also save files in the root directory and select `main branch`.
-You'll need to place a `.nojekyll` file in the deploy location (such as `/docs`
-or the gh-pages branch)
+# Deploy
+
+## On Your Local Machine
+
+You can deploy Visualify on your local machine by running a simple HTTP server.
+For example, you can use the `http-server` package from npm:
+
+```bash
+npm install -g http-server
+http-server ./docs
+```
+
+Then open your browser and navigate to `http://localhost:8080`.
+
+## On GitHub Pages
+
+There are three places to populate your docs for your GitHub repository:
+
+-   `docs/` folder
+-   main branch
+-   gh-pages branch
+
+It is recommended that you save your files to the `./docs` subfolder of the
+`main` branch of your repository. Then select `main branch /docs folder` as your
+GitHub Pages source in your repository's settings page.
+
+![GitHub Pages](./static/_images/deploy-github-pages.png)
+
+!> You can also save files in the root directory and select `main branch`.
+You'll need to place a `.nojekyll` file in the deploy location (such as `/docs`
+or the gh-pages branch)