EzGitDoc

Loading

classic 1.7.6

EzGitDoc

Docs

Elements
Code Alt + Q
Header Alt + W
Image Alt + E
Link Alt + R
List Alt + A
Table Alt + S
Text Alt + D
Badge Alt + F
Details Alt + Z
Extra
Quickbuilder(v1.0)

Create element

OR

Review documentation

Definition

In short, it's quick and easy tool, allowing to setup and generate interesting templates of *.md files that are mostly used for repositories documentation. One of it's crucial advantages is that it focuses more on clicking than writing. Plan your doc, fill in data and get code!

Get Started

If you are not familiar with EzGitDoc, you can start by simply trying each element that can be created or take a look at Quick Start for very fast briefing, and optionally, visit also Examples section for short capabilities demonstration.

Contribution & Contact

Want to take part in making EzGitDoc more powerful and advanced for the community? Feel free to contact via this form or Discord. List of options that you can work on can be found here. You are welcome!

EzGitDoc

Did you miss to fill in header text?

Themes

References

Use pin icon to quickly change element's position

Settings

Automated modals: enabled Decide whether modals should be closed automatically on successful object render(enabled) or not(disabled).

Autohide notifications: disabled If enabled, error messages will be shown for limited time of 7 seconds. When disabled, notifications need to be closed manually.

Hint keys: disabled Enable this option to see shortkeys hints for each element from the sidebar elements section.

Nonspaced elements: disabled Enable this setting to remove spaces between elements in EzGitDoc. Disable it to retrieve bottom margins back.

Delete confirmation: disabled Enable this option to require confirmation before deleting single element in EzGitDoc. If disabled, single elements are deleted without confirmation.

EzGitDoc Single Element Font Size
Active: 60%

Close

Are you sure?

Yes No

Are you sure?

Yes No

Set new position for element [1, 26]

Set

Code

Language (optional)

Code (required)

Did you know?

Use TAB key to make indentation in Code.
Textareas in EzGitDoc are resizable.
GitHub supported languages can be found here.

Code Update

Language

Code

Header

Text (required)

Style (optional, default = h2)

h1
h2
h3
h4
h5
h6

Header Update

Text

Style

h1
h2
h3
h4
h5
h6

Image

Alternate text (required)

URL (required) If you don't have URL yet, leave blank.

Alignment (optional, default = center)

Size

X axis (width)

Y axis (height)

At least one axis needs to be set.
(it's value must be higher than 0)

Image Update

Alternate text

URL

Alignment

Size

X axis (width)

Y axis (height)

Link

Text (required)

Href (required)

Did you know?

If you want to create more than one link, you can use link list or linked kbd table. You can also make link in text element using anchor tag(a).

Link Update

Text

Href

List

Size (required)

Type (required)

iconic
normal
link

Hover over magnifier icon to see the example. Click on the desired type to confirm choice.

Got icon? Type name here For the list of icons supported by GitHub, refer here.

Did you know?

If you won't specify icon for iconic list, EzGitDoc will put unique Id that can be easily changed later.
You can extend lists and text tables during update process.

List Update

Data

Table

Dimensions (required)

Rows

Columns

Type (required)

text
image
kbd image
linked kbd image

Hover over magnifier icon to see the example. Click on the type to make choice.

Table Update

Data

Table Update

New images dimensions (required)

Width

Height

Text

Text (optional)

text justification

Did you know?

Leave text field empty if you want to use lorem ipsum template.
You can use HTML markup in the text area like:
<a href="address"> text </a> (to create link)
<strong> text </strong> (to bold text)
<em> text </em> (to emphasis text)
<del> text </del> (to strike text)
etc.

Text Update

Text:

text justification

Badge

Label (required, max 25 characters)

Message (required, max 25 characters)

Color (required)

Style (optional)

Did you know?

Visit Shields.io page to get predefined badges or to create more advanced one.

Badge Update

Label (required, max 25 characters)

Message (required, max 25 characters)

Color (required)

Style (optional)

Details

Summary (required, max 60 characters)

Body (required)

Did you know?

HTML markup is allowed in Body and Summary.

Details Update

Summary (required, max 60 characters)

Body (required)

Summary field is limited to 40 characters.
HTML markup is allowed in Body text area and Summary field.

Contact

Subject e.g. EzGitDoc: taking part in a project

Your email

Text Max 200 characters

Quickbuilder 1.0

Terminal

Elements with extra parameters
Hover over example to see more information.

                header{H2}
                image{250}
                list{normal-4}
                table{text-2|4}
                label{#4256f5}
              

Left whitespace is included automatically

Generated Output

Success!

Generated Code