Skip to content

Commit be5defc

Browse files
committed
feat(docs): getting started page
1 parent 19b1e9f commit be5defc

File tree

14 files changed

+114
-36
lines changed

14 files changed

+114
-36
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<template>
2+
<svg
3+
width="100%"
4+
height="30"
5+
viewBox="0 0 707 169"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
>
9+
<path
10+
d="M199.625 122V53.4688H214.156V122H199.625ZM260.047 68.6094C265.641 68.6094 270.141 70.1406 273.547 73.2031C276.953 76.2344 278.656 81.1094 278.656 87.8281V122H264.359V91.3906C264.359 87.6406 263.672 84.8125 262.297 82.9062C260.953 81 258.828 80.0469 255.922 80.0469C251.547 80.0469 248.562 81.5312 246.969 84.5C245.375 87.4688 244.578 91.75 244.578 97.3438V122H230.281V69.5938H241.203L243.125 76.2969H243.922C245.047 74.4844 246.438 73.0156 248.094 71.8906C249.781 70.7656 251.641 69.9375 253.672 69.4062C255.734 68.875 257.859 68.6094 260.047 68.6094ZM309.969 122.938C304.125 122.938 299.359 120.656 295.672 116.094C292.016 111.5 290.188 104.766 290.188 95.8906C290.188 86.9219 292.047 80.1406 295.766 75.5469C299.484 70.9219 304.344 68.6094 310.344 68.6094C312.844 68.6094 315.047 68.9531 316.953 69.6406C318.859 70.3281 320.5 71.25 321.875 72.4062C323.281 73.5625 324.469 74.8594 325.438 76.2969H325.906C325.719 75.2969 325.484 73.8281 325.203 71.8906C324.953 69.9219 324.828 67.9062 324.828 65.8438V49.0625H339.172V122H328.203L325.438 115.203H324.828C323.922 116.641 322.781 117.953 321.406 119.141C320.062 120.297 318.453 121.219 316.578 121.906C314.703 122.594 312.5 122.938 309.969 122.938ZM314.984 111.547C318.891 111.547 321.641 110.391 323.234 108.078C324.859 105.734 325.719 102.219 325.812 97.5312V95.9844C325.812 90.8906 325.031 87 323.469 84.3125C321.906 81.5938 319 80.2344 314.75 80.2344C311.594 80.2344 309.125 81.5938 307.344 84.3125C305.562 87.0312 304.672 90.9531 304.672 96.0781C304.672 101.203 305.562 105.062 307.344 107.656C309.156 110.25 311.703 111.547 314.984 111.547ZM375.734 68.6094C380.578 68.6094 384.75 69.5469 388.25 71.4219C391.75 73.2656 394.453 75.9531 396.359 79.4844C398.266 83.0156 399.219 87.3281 399.219 92.4219V99.3594H365.422C365.578 103.391 366.781 106.562 369.031 108.875C371.312 111.156 374.469 112.297 378.5 112.297C381.844 112.297 384.906 111.953 387.688 111.266C390.469 110.578 393.328 109.547 396.266 108.172V119.234C393.672 120.516 390.953 121.453 388.109 122.047C385.297 122.641 381.875 122.938 377.844 122.938C372.594 122.938 367.938 121.969 363.875 120.031C359.844 118.094 356.672 115.141 354.359 111.172C352.078 107.203 350.938 102.203 350.938 96.1719C350.938 90.0469 351.969 84.9531 354.031 80.8906C356.125 76.7969 359.031 73.7344 362.75 71.7031C366.469 69.6406 370.797 68.6094 375.734 68.6094ZM375.828 78.7812C373.047 78.7812 370.734 79.6719 368.891 81.4531C367.078 83.2344 366.031 86.0312 365.75 89.8438H385.812C385.781 87.7188 385.391 85.8281 384.641 84.1719C383.922 82.5156 382.828 81.2031 381.359 80.2344C379.922 79.2656 378.078 78.7812 375.828 78.7812ZM421.578 95.2344L404.703 69.5938H420.922L431.094 86.2812L441.359 69.5938H457.578L440.516 95.2344L458.375 122H442.109L431.094 104.047L420.031 122H403.812L421.578 95.2344ZM461.703 102.125V90.4062H486.875V102.125H461.703ZM533.844 106.438C533.844 110 533 113.016 531.312 115.484C529.656 117.922 527.172 119.781 523.859 121.062C520.547 122.312 516.422 122.938 511.484 122.938C507.828 122.938 504.688 122.703 502.062 122.234C499.469 121.766 496.844 120.984 494.188 119.891V108.078C497.031 109.359 500.078 110.422 503.328 111.266C506.609 112.078 509.484 112.484 511.953 112.484C514.734 112.484 516.719 112.078 517.906 111.266C519.125 110.422 519.734 109.328 519.734 107.984C519.734 107.109 519.484 106.328 518.984 105.641C518.516 104.922 517.484 104.125 515.891 103.25C514.297 102.344 511.797 101.172 508.391 99.7344C505.109 98.3594 502.406 96.9688 500.281 95.5625C498.188 94.1562 496.625 92.5 495.594 90.5938C494.594 88.6562 494.094 86.2031 494.094 83.2344C494.094 78.3906 495.969 74.75 499.719 72.3125C503.5 69.8438 508.547 68.6094 514.859 68.6094C518.109 68.6094 521.203 68.9375 524.141 69.5938C527.109 70.25 530.156 71.2969 533.281 72.7344L528.969 83.0469C526.375 81.9219 523.922 81 521.609 80.2812C519.328 79.5625 517 79.2031 514.625 79.2031C512.531 79.2031 510.953 79.4844 509.891 80.0469C508.828 80.6094 508.297 81.4688 508.297 82.625C508.297 83.4688 508.562 84.2188 509.094 84.875C509.656 85.5312 510.719 86.2656 512.281 87.0781C513.875 87.8594 516.203 88.875 519.266 90.125C522.234 91.3438 524.812 92.625 527 93.9688C529.188 95.2812 530.875 96.9219 532.062 98.8906C533.25 100.828 533.844 103.344 533.844 106.438ZM566.469 68.5156C573.5 68.5156 578.891 70.0469 582.641 73.1094C586.391 76.1719 588.266 80.8281 588.266 87.0781V122H578.281L575.516 114.875H575.141C573.641 116.75 572.109 118.281 570.547 119.469C568.984 120.656 567.188 121.531 565.156 122.094C563.125 122.656 560.656 122.938 557.75 122.938C554.656 122.938 551.875 122.344 549.406 121.156C546.969 119.969 545.047 118.156 543.641 115.719C542.234 113.25 541.531 110.125 541.531 106.344C541.531 100.781 543.484 96.6875 547.391 94.0625C551.297 91.4062 557.156 89.9375 564.969 89.6562L574.062 89.375V87.0781C574.062 84.3281 573.344 82.3125 571.906 81.0312C570.469 79.75 568.469 79.1094 565.906 79.1094C563.375 79.1094 560.891 79.4688 558.453 80.1875C556.016 80.9062 553.578 81.8125 551.141 82.9062L546.406 73.25C549.188 71.7812 552.297 70.625 555.734 69.7812C559.203 68.9375 562.781 68.5156 566.469 68.5156ZM574.062 97.7188L568.531 97.9062C563.906 98.0312 560.688 98.8594 558.875 100.391C557.094 101.922 556.203 103.938 556.203 106.438C556.203 108.625 556.844 110.188 558.125 111.125C559.406 112.031 561.078 112.484 563.141 112.484C566.203 112.484 568.781 111.578 570.875 109.766C573 107.953 574.062 105.375 574.062 102.031V97.7188ZM632.797 68.6094C638.391 68.6094 642.891 70.1406 646.297 73.2031C649.703 76.2344 651.406 81.1094 651.406 87.8281V122H637.109V91.3906C637.109 87.6406 636.422 84.8125 635.047 82.9062C633.703 81 631.578 80.0469 628.672 80.0469C624.297 80.0469 621.312 81.5312 619.719 84.5C618.125 87.4688 617.328 91.75 617.328 97.3438V122H603.031V69.5938H613.953L615.875 76.2969H616.672C617.797 74.4844 619.188 73.0156 620.844 71.8906C622.531 70.7656 624.391 69.9375 626.422 69.4062C628.484 68.875 630.609 68.6094 632.797 68.6094Z"
11+
fill="currentColor"
12+
/>
13+
<path
14+
fill-rule="evenodd"
15+
clip-rule="evenodd"
16+
d="M79 158C122.63 158 158 122.63 158 79C158 35.3695 122.63 0 79 0C35.3695 0 0 35.3695 0 79C0 122.63 35.3695 158 79 158ZM56 39C53.2386 39 51 41.2386 51 44V45.4286C51 48.19 53.2386 50.4286 56 50.4286H73.8571V107.571H56C53.2386 107.571 51 109.81 51 112.571V114C51 116.761 53.2386 119 56 119H102C104.761 119 107 116.761 107 114V112.571C107 109.81 104.761 107.571 102 107.571H85.2857V50.4286H102C104.761 50.4286 107 48.19 107 45.4286V44C107 41.2386 104.761 39 102 39H56Z"
17+
fill="currentColor"
18+
/>
19+
</svg>
20+
</template>

packages/docs/content/1.guide/0.index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

packages/docs/content/0.index.md renamed to packages/docs/content/en-US/0.index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ cta:
1111
- /guide
1212
secondary:
1313
- Open on GitHub →
14-
- https://github.com/nuxtlabs/docus
14+
- https://github.com/sidekick-coder/index-san
1515
---
1616

1717
#title
@@ -29,4 +29,4 @@ Use a powerful combination of markdown, charts, js code to build your productivi
2929
- **Based on Filesystem:** All your data is saved locally and you have full control of everything.
3030
::
3131
::
32-
::
32+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Get started
2+
3+
## Download
4+
5+
Download the app from the releases page:
6+
7+
:button-link[Releases page]{icon="material-symbols:rocket-launch" href="https://github.com/sidekick-coder/index-san/releases" blank}
8+
9+
10+
## Create the first workspace
11+
12+
Workspace need a name and a path, that must be a valid filesystem path
13+
14+
![create-workspace-dialog](/workspace.create.dialog.jpeg)
15+
16+
Then you can activate the workspace with the checkbox
17+
18+
![workspace-list-page](/workspace.list-page.active.jpeg)
19+
20+
With this you already good to go.
21+
22+
![entries-page](/entries.page.jpeg)
23+
24+
25+
## Next
26+
27+
::list{type="info"}
28+
29+
- [Create collections](/guide/create-collections)
30+
- [Create scripts](/guide/create-scripts)
31+
32+
::
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Index-san
3+
navigation: false
4+
layout: page
5+
---
6+
7+
::block-hero
8+
---
9+
cta:
10+
- Primeiros passos
11+
- /guia
12+
secondary:
13+
- Ver GitHub →
14+
- https://github.com/nuxtlabs/docus
15+
---
16+
17+
#title
18+
Organize your Notes and Databases in the way you want
19+
20+
#description
21+
Use a powerful combination of markdown, charts, js code to build your productivity system the way you want.
22+
23+
#extra
24+
::list
25+
- **Markdown notes:** create notes using markdown syntax.
26+
- **Markdown components:** buttons, cards, inputs, etc...
27+
- **Charts:** create beautiful charts based in your data.
28+
- **Custom scripts:** Run simple tasks like importer data from internet or other files.
29+
- **Based on Filesystem:** All your data is saved locally and you have full control of everything.
30+
::
31+
::
32+

packages/docs/nuxt.config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
export default defineNuxtConfig({
22
extends: '@nuxt-themes/docus',
3+
content: {
4+
locales: ['en-US', 'pt-BR'],
5+
defaultLocale: 'en-US',
6+
},
37
})
13 KB
Loading

packages/docs/public/icon.png

-92.3 KB
Loading

0 commit comments

Comments
 (0)