Documents
seamlessly document the Products & Features without thinking about how to organize the documentation, access the automatically structured documentation (as an AJIR user but also external) and search.
coming soon...
Keyboards shortcuts
Window +
. => insert emoji
CTRL +
H => h1, h2, h3
B => bold
I => italic
U => underline
P => change text color
S => strikethrough
Q => block quote
D => code block
L => bullet list, numbered list
A => admonition: info, warning, danger
C => copy
X => cut
V => paste
Z => undo
Y => redo
F => find on page
Dev documentation
write markdown files in the code repository and AJIR will automatically pick them up and add them the product and feature documentation. AJIR will also fetch the README file.
Developers can maintain a Dev documentation in the code repository and AJIR will add them to the Product & Feature documentation.
Documentation files must live in a folder named 'ajir_dev_documentation' and the format supported is markdown.
Documentation files must be named after the product's or feature's key (e.g. p-24.md or f-24.md). AJIR will automatically pick them up and add them to the corresponding product's or feature's documentation.
AJIR will also fetch the README.md file and add it to the product's documentation.
For the feature to work, you must have a repository and a valid token setup anywhere in the upper Product tree.
Documents
create Documents composed of reusable Blocks of information/knowledge. Label them to categorize and use them through AJIR API as a Headless CMS.
In AJIR, a Document is a piece of information composed of reusable Blocks.
The Blocks content is searchable with AJIR global search.
Documents are also used in the self-organizing product documentation feature of AJIR.
You can also create labels for Documents, in order to further categorize and query them with AJIR API. By doing so, you can re-use your AJIR Documents and use AJIR as a Headless CMS, e.g. to populate a blog or a landing page.