Inteligentny Dom

Markdown demo

Inline styles

Text can be bold, italic, or strikethrough.

You can link to another page.

You can highlight inline code with backticks.

I need to highlight these very important words.

H2O and X2

That is so funny! 😂

Markdown

SyntaxDescription
HeaderTitle
ParagraphText

Here’s a sentence with a footnote. 1

term
definition
  • Write the press release
  • Update the website
  • Contact the media

Blockquotes

This is a blockquote, which is commonly used when quoting another person or document. Blockquotes are indicated by a > at the start of each line.

Callouts

This is a note callout. Example text to show it in action.

Note

Doks is a documentation website toolkit built with Hyas. You can get started with this command:

npm create hyas@latest -- --template doks

Did you know?

Hyas simplifies developer on boarding time and makes for faster collaboration by using a single declaration manifest for dependencies.

Caution

If you are not sure you want an awesome docs site, think twice before using Doks.

Danger

Your users may be more productive and find your product easier to use thanks to helpful Doks features.

Details

DetailsSomething small enough to escape casual notice.
Start in open stateThis Boolean attribute indicates whether the details — that is, the contents of the <details> element — are currently visible. The details are shown when this attribute exists, or hidden when this attribute is absent. By default this attribute is absent which means the details are not visible.

Tabs

npm create hyas@latest
pnpm create hyas@latest
yarn create hyas

Tabler Icons

Theme is using Tables Icons that you can embbed.

Math

Read more in Dosk Math docs.

mathematical expression or equation mathematical expression or equation

An inline mathematical expression or equation expression.

Diagrams

Read more in Doks Diagrams docs based on Kroki.

D2

diagram

Mermaid

diagram

PlantUML

diagram

Code blocks

if ([1,"one",2,"two"].includes(value)){
  console.log("Number is either 1 or 2.");  // comment
}
count.js
if ([1,"one",2,"two"].includes(value)){
  console.log("Number is either 1 or 2.");  // comment
}

Terminal

npm install @hyas/doks-core@latest
Installing dependencies…
npm install
npm install @hyas/doks-core@latest
32if ([1,"one",2,"two"].includes(value)){
33  console.log("Number is either 1 or 2.");  // comment
34}
if ([1,"one",2,"two"].includes(value)){
  console.log("Number is either 1 or 2.");  // comment
}

Video

Images

Read more on Hays Images.

Img

ShortCode Reference

A white bird flying over a lush green field

Picture

ShortCode Reference

A bird flying through a field of tall grass

Figure

ShortCode Reference

A small bird sitting on top of a dry grass field
A small bird sitting on top of a dry grass field. Photo by Vincent van Zalinge

SVG

TODO add

With desc

Showcase

Explore the infinite possibilities of Doks

Without

Showcase

Grid

Showcase
Showcase

Fruther readings

  1. This is the footnote. ↩︎

Ostatnio zaktualizowano 8 kwietnia 2024
Poprzedni
Polityka Prywatności
Następny
test