From a45df1373edf1ef11125db2db0a311c88d1119b0 Mon Sep 17 00:00:00 2001 From: bellord13 Date: Wed, 25 Aug 2021 18:49:45 +0300 Subject: [PATCH] fix --- README.md | 169 +++++++----------------------------------------------- 1 file changed, 22 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index d6c166b..7d100be 100644 --- a/README.md +++ b/README.md @@ -52,22 +52,33 @@ PluginManager.exec(deps, callback, argArr, context) ```sh PluginManager.ready(deps, callback) ``` +> `kit.config.requiredDependencies` определяет зависимости (deps) по умолчанию +## Глобальный конфиг + +Параметры определяются в плагине `config` + +> Параметры допустимо определять до загрузки `PluginManager` + +| name | default | description | +| --- | --- | --- | +| defaultPath | /local/templater.dev/kit/assets | | +| requiredDependencies | ['bsCore', 'toolkit'] | дополнительно определяет список зависимостей для любого колбека вызванного функциями `exec` и `ready` | +| autoloadPluginList | ['tooltip'] | Автоматически загрузит ресурсы указанных плагинов. В случае модуля с типом `loader` код не будет исполнен сразу после загрузки. Исполнение бдует определятся функций `install` | +| debug | false | Расширит список выводимой в консоль информации | + + + +## z-index map + +| z-index | plugin | selector | +| --- | --- | --- | +| 100 | flex-kit | .flex-card:hover .flex-card__content | ✨ Magic ✨ -## Features -- Import a HTML file and watch it magically convert to Markdown -- Drag and drop images (requires your Dropbox account be linked) -- Import and save files from GitHub, Dropbox, Google Drive and One Drive -- Drag and drop markdown and HTML files into Dillinger -- Export documents as Markdown, HTML and PDF - -Markdown is a lightweight markup language based on the formatting conventions -that people naturally use in email. -As [John Gruber] writes on the [Markdown site][df1] > The overriding design goal for Markdown's > formatting syntax is to make it as readable @@ -77,154 +88,18 @@ As [John Gruber] writes on the [Markdown site][df1] > looking like it's been marked up with tags > or formatting instructions. -This text you see here is *actually- written in Markdown! To get a feel -for Markdown's syntax, type some text into the left window and -watch the results in the right. -## Tech -Dillinger uses a number of open source projects to work properly: +## Установка -- [Ace Editor] - awesome web-based text editor -- [Twitter Bootstrap] - great UI boilerplate for modern web apps -- [jQuery] - duh -And of course Dillinger itself is open source with a [public repository][dill] - on GitHub. -## Installation - -Dillinger requires [Node.js](https://nodejs.org/) v10+ to run. - -Install the dependencies and devDependencies and start the server. - -```sh -cd dillinger -npm i -node app -``` - -For production environments... - -```sh -npm install --production -NODE_ENV=production node app -``` - -## Plugins - -Dillinger is currently extended with the following plugins. -Instructions on how to use them in your own application are linked below. - -| Plugin | README | -| ------ | ------ | -| Dropbox | [plugins/dropbox/README.md][PlDb] | -| GitHub | [plugins/github/README.md][PlGh] | -| Google Drive | [plugins/googledrive/README.md][PlGd] | -| OneDrive | [plugins/onedrive/README.md][PlOd] | -| Medium | [plugins/medium/README.md][PlMe] | -| Google Analytics | [plugins/googleanalytics/README.md][PlGa] | - -## Development - -Want to contribute? Great! - -Dillinger uses Gulp + Webpack for fast developing. -Make a change in your file and instantaneously see your updates! - -Open your favorite Terminal and run these commands. - -First Tab: - -```sh -node app -``` - -Second Tab: - -```sh -gulp watch -``` - -(optional) Third: - -```sh -karma test -``` - -#### Building for source - -For production release: - -```sh -gulp build --prod -``` - -Generating pre-built zip archives for distribution: - -```sh -gulp build dist --prod -``` - -## Docker - -Dillinger is very easy to install and deploy in a Docker container. - -By default, the Docker will expose port 8080, so change this within the -Dockerfile if necessary. When ready, simply use the Dockerfile to -build the image. - -```sh -cd dillinger -docker build -t /dillinger:${package.json.version} . -``` - -This will create the dillinger image and pull in the necessary dependencies. -Be sure to swap out `${package.json.version}` with the actual -version of Dillinger. - -Once done, run the Docker image and map the port to whatever you wish on -your host. In this example, we simply map port 8000 of the host to -port 8080 of the Docker (or whatever port was exposed in the Dockerfile): - -```sh -docker run -d -p 8000:8080 --restart=always --cap-add=SYS_ADMIN --name=dillinger /dillinger:${package.json.version} -``` - -> Note: `--capt-add=SYS-ADMIN` is required for PDF rendering. - -Verify the deployment by navigating to your server address in -your preferred browser. - -```sh -127.0.0.1:8000 -``` ## License MIT -**Free Software, Hell Yeah!** [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax) [dill]: - [git-repo-url]: - [john gruber]: - [df1]: - [markdown-it]: - [Ace Editor]: - [node.js]: - [Twitter Bootstrap]: - [jQuery]: - [@tjholowaychuk]: - [express]: - [AngularJS]: - [Gulp]: - - [PlDb]: - [PlGh]: - [PlGd]: - [PlOd]: - [PlMe]: - [PlGa]: