Skip to content

Commit

Permalink
feat: update first time onboarding
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinslin committed Jul 7, 2020
1 parent 1da29ec commit 1edadf2
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,6 @@ There are several additional extensions that work well with Dendron but are not
- [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks)
- Bookmark lines within Files

## Caveats

- 🚧 Extra files being created
- Dendron currently creates a `root.md` file and a `root.schema.yml` file where you initialize your vault. these files will be used in the future to automatically generate an index of everything in your vault. you may safely ignore them for now
- Frontmatter
- currently, you might see the following text added to the top of your note. This is additional metadata that Dendron uses to manage your files.

```yml
---
id: 4407f75d-7334-47a5-9f19-18b458618136
title: dendron.lookup.hello
desc: ''
updated: 1594078624566
created: 1594078624566
data: {}
custom: {}
fname: dendron.lookup.hello
parent: null
children: []
---
```


## Themes

Expand All @@ -70,4 +48,6 @@ We've only scratched the surface of what you can do with Dendron. Because Dendro

If for some reason, there is functionality that is missing still, you can always build your own or submit an issue on the [Dendron Roadmap](https://github.com/dendronhq/dendron-roadmap/issues/new)

Be sure to checkout the [[dendron.faq]] first to see if your issue is already mentioned.

Meanwhile, if you have any feedback or want to talk about anything note taking or second brain related, you can do so by joining our [discord community](https://discord.gg/6j85zNX) (like slack but without the message limits) or emailing me directly at `kevin(at)thence.io`.
30 changes: 30 additions & 0 deletions packages/plugin-core/assets/notes/vault.main/dendron.faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# FAQ

### How do I save?
- Dendron automatically saves when you change focus (switch tabs or applications). You can also manually save using `CMD+S` or `CTRL+S` depending on your operating system

### Extra files being created
- Dendron currently creates a `root.md` file and a `root.schema.yml` file where you initialize your vault. these files will be used in the future to automatically generate an index of everything in your vault. you may safely ignore them for now

### What is the extra text that is created at the beginning of each note?
- currently, you might see the following text added to the top of your note. This is additional metadata that Dendron uses to manage your files.

```yml
---
id: 4407f75d-7334-47a5-9f19-18b458618136
title: dendron.lookup.hello
desc: ''
updated: 1594078624566
created: 1594078624566
data: {}
custom: {}
fname: dendron.lookup.hello
parent: null
children: []
---
```


### Why are there two `book` icons that do markdown preview?

We use an extension to do markdown preview. VSCode comes with its default markdown preview extension and its not currently possible to hide the button. You can re-open and upvote the issue [here](https://github.com/microsoft/vscode/issues/86994) if you want to fix this.

0 comments on commit 1edadf2

Please sign in to comment.