Skip to content

Commit

Permalink
update docs in English
Browse files Browse the repository at this point in the history
  • Loading branch information
Eugeon committed Oct 23, 2023
1 parent ada5f47 commit d695128
Show file tree
Hide file tree
Showing 49 changed files with 2,870 additions and 0 deletions.
Binary file added en/_images/leading.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/overview_landing_black.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/overview_landing_white.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/terms_sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/user-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_images/user_settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/_includes/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fake file
19 changes: 19 additions & 0 deletions en/_includes/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
| Plugin name | Description | Parameters | Added</br>by default |
|--------------| --- | --- | --- |
| **Anchors** | Automatically generate [anchors for headers](../syntax/base.md#headers) | `extractTitle`: Consider the first level header</br>(type: bool, default value: false)</br></br>`supportGithubAnchors`: Generate additional anchors compatible with GitHub</br>(type: bool, default value: false) | + |
| **code** | Display the copy button in [code blocks](../syntax/code.md#block) | - | + |
| **Cut** | Support for the [cut](../syntax/cuts-tabs.md#cuts) markup | - | + |
| **Deflist** | Support for the [definition list](../syntax/lists.md#terms) markup | - | + |
| **File** | Support for the [file objects](../syntax/links.md#files) markup | `fileExtraAttrs`: additional attributes for the link | + |
| **Tasks list** | Support for the [tasks list](../syntax/additional.md#tasks-list) | `divClass`: classname for div wrapping the checkbox</br>(type: string, default value: checkbox)</br></br> `idPrefix`: prefix for checkbox id</br>(type: string, default value: checkbox) | - |
| **Images** | Add [images](../syntax/media.md#images) | `assetsPublicPath`: Path to icons</br>(type: string, default value: /) | - |
| **Imsize** | Set the image size | - | - |
| **Includes** | Reuse content in a document | `getVarsPerFile`: A function that returns calculated variables using the path to the file</br>(type: function, default value: -) | - |
| **Links** | Expand [link syntax](../syntax/links.md) | - | - |
| **Meta** | Add [metadata](../syntax/meta.md#meta) to the beginning of files | - | + |
| **Notes** | Support for the [note](../syntax/notes.md) markup | `lang`: A language for displaying the note type</br>(type: string, default: ru) | + |
| **Sup** | Output text as [superscript](../syntax/base.md#line) | - | + |
| **Table** | Support for [multiline tables](../syntax/tables/multiline.md) | - | + |
| **Tabs** | Support for the [tab](../syntax/cuts-tabs.md#tabs) markup | - | + |
| **Video** | Add a [video](../syntax/media.md#video) | - | + |

30 changes: 30 additions & 0 deletions en/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Diplodoc

Diplodoc Platform is open platform for work with your documentation in accordance with "Documentation as a Code" paradigm.
Simple and comfortable solution for everyone.

## Advantages of the platform
### Easy to use
- Work with documents in the same way as with code
- Minimal efforts for deployment and integration

### Speed
- Fast validation, build and deploy for your projects
- Easy integration with your developement pipelines

### Full support of Markdown
- Simple syntax
- Easy learning
- Concentration on content creation, not deployment
- Rich functionality

### Support for complex Documentation projects
- Customization and localization
- “One Source” support
- Add more functionality with plugins even

### Supports for autogenerated documentation
- OpenAPI support out of the box
- Custom includer’s interface for any kind of autogenerated docs (JavaDoc, etc..)


343 changes: 343 additions & 0 deletions en/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,343 @@
# Revision history

## December 2022

### yfm-docs

#### 2.0.0

- [New Includers Interface](./project/toc.md#includers)
- [Generic Includer](./project/toc.md#includers-generic)
- [Open API Includer](./project/toc.md#includers-open-api)
- [Unarchive Includer](./project/toc.md#includers-unarchive)
- [Source Docs Includer](./project/toc.md#includers-source-docs)

## November 2022

### yfm-docs

#### 1.31.0

- Added support for [definitions](./syntax/term.md).

### yfm-transform

#### 2.16.0

- Added support for inline markup in [task lists](./syntax/additional.md#tasks-list)

#### 2.15.0

- Added `linkifyTlds` option that allows configure tld for the linkify plugin.

## September 2022

### yfm-docs

#### 1.26.0

- services/leading: add [substitutions and conditional operators support](./project/leading-page.md#subtitudes) on leading page for title and description.
- services/tocs: add [substitutions and conditional operators support](./project/toc.md#subtitudes) in document title.

#### 1.24.0

- includers/openapi: allows autogeneration from openapi specification and inclusion into the main document.
[Open API](./project/toc.md#open-api)

### yfm-transform

#### 2.14.0

- Added sanitizing of generated HTML. Disabled by default. Parameter to enable: `needToSanitizeHtml: true`. You can override the default settings via the `sanitizeOptions` parameter.

#### 2.13.0

- Added syntax for [definitions](./syntax/term.md).

#### 2.12.0

- Functionality to [set image size](./syntax/media.md) enabled by default.

## August 2022

### yfm-transform

#### 2.11.0

- Support for inline formatting in the title of cuts and notes.

#### 2.10.0

- Added the `needFlatListHeadings?: boolean;` parameter, which allows to form a flat list of all document headers in `transform().result.headings`. By default – `false`.

## July 2022

### yfm-docs

#### 1.23.0

- include/includers: allows 3rd party generated content integration into documentation.
- include/includers/sourcedocs: allows you to integrate sourcedocs generated document into yfm documentation.
[Includers](./project/toc.md#includers).

## June 2022

### yfm-transform

#### 2.9.0

- Added plugin for [file links](./syntax/links.md#files)

#### 2.8.0

- Spaces inside inline conditions are not deleted.

#### 2.7.0

- Single-page logic has been removed from the plugins (temporarily reverted in version 2.8.2).

## May 2022

### yfm-transform

#### 2.6.0

- Added plugin for [task lists syntax](./syntax/additional.md#tasks-list).

## April 2022

### yfm-docs

#### 1.22.0

- Support filtering of the title and title of the meta on the leading page (index.yaml).
- Support filtering of the title on the contents (toc.yaml).

#### 1.21.0

- Supported using of symlinks with a relative path.

## March 2022

### yfm-docs

#### 1.20.0

- Supported filtering of the description on the leading page (index.yaml).

#### 1.19.0

- The linter runs in parallel with the build
- The arguments `--link-disabled`, `--build-disabled` and `--add-map-file` are supported, by default they have the value `false`.
[Read more](tools/docs/settings.md)

### yfm-transform

#### 2.5.0

- Rewritten in Typescript.

## December 2021

### yfm-docs

#### 1.18.0

Update YFM to v2.4. Added support [monospaced text](./syntax/base.md) and [multiline tables](./syntax/tables/multiline.md).

#### 1.17.0

* After pre-processing the documentation (with output-format=md), we do not remove not_var from the syntax similar to variables.
[Substitutions](./syntax/vars.md#subtitudes)

#### 1.16.0

* Added modes for including toc: `root_merge`, `merge`, `link`. [Read more](./project/toc.md#include-mode).

* If the toc includes another one under the `root_merge` and `merge` modes, the original path will be added
to the `sourcePath` meta field.

### yfm-transform

#### 2.4.0

* [Multiline tables](./syntax/tables/multiline.md) enabled by default.

#### 2.3.0

* Added support [monospaced text](./syntax/base.md).

## November 2021

### yfm-docs

#### 1.15.0

* Added the ability to include `toc.yaml` with the addition of its elements to the same table of contents level.

[Read more](./project/toc.md#include-as-pages)

#### 1.14.0

* Added the ability to [configure the linter](./project/lint.md).

### yfm-transform

#### 2.2.0

* Added the ability to redefine delimiters in the plugin [markdown-it-attrs](https://www.npmjs.com/package/markdown-it-attrs).

## October 2021

### yfm-transform

#### 2.1.0

* Added beta-plugin for support multiline tables.

## September 2021

### yfm-docs

#### 1.13.0

* YFM2 is used.

### yfm-transform

#### 2.0

* YFM can be used on the client.
* The plug-in connection scheme has been changed.
* The [markdown-it-attrs](https://www.npmjs.com/package/markdown-it-attrs) plugin is always connected.
* The [highlight.js](https://www.npmjs.com/package/highlight.js) package must be installed independently.

## July 2021

### yfm-docs

#### 1.12.0

* The experimental YFM linter was disabled.

### yfm-transform

#### 1.9.0

* Added the ability to enable support for GitHub compatible anchors (GFM).

## June 2021

### yfm-docs

#### 1.11.0

* An experimental YFM linter was enabled.

#### 1.10.0

* Now you can configure redirects using a special file. Static builds are not supported.

#### 1.9.0

* Added support for sections accessible only by direct link.

### yfm-transform

#### 1.8.0

* Added experimental linter support.

## April 2021

### yfm-docs

#### 1.8.0

* Added the option to add file contributors to metadata. Only GitHub is supported out-of-the-box. It isn't displayed visually in any way, but can be used by a custom viewer.

## March 2021

### yfm-docs

#### 1.7.0

* Added complete disabling of variables: conditions are not calculated and values are not substituted.

### yfm-transform

#### 1.7.0

* Added complete disabling of variables: conditions are not calculated and values are not substituted.

## January 2021

### yfm-docs

#### 1.6.0

* Now you can build a document as a single HTML file.

#### 1.5.0

* Refactoring and bug fixes.

#### 1.4.0

* Added disabling the calculation of conditions with variables.

### yfm-transform

#### 1.6.0

* Added support for loops, filters, and functions.

#### 1.5.0

* Added a feature to use the `not_var` flag for variables that don't need to be substituted with values. For example, `not_var{{ variable_name }}`.

## October 2020

### yfm-docs

#### 1.3.0

* Added the ability to display built files on S3.

## August 2020

### yfm-docs

#### 1.2.0

* Now the documentation interface allows the user to change the font size, turn on the dark theme, and hide the table of contents.

### yfm-transform

#### 1.4.0

* Added an option to use '|' in variables.

## July 2020

### yfm-transform

#### 1.3.0

* Basic element styles have been updated.

#### 1.2.0

* Added support for inserting videos.

#### 1.1.0

* Added support for multiple custom anchors per header.

## June 2020

### yfm-docs

#### 1.1.0

* Added silent mode without outputting build logs.
Loading

0 comments on commit d695128

Please sign in to comment.