dendronhq / dendron-site Goto Github PK
View Code? Open in Web Editor NEWGetting started with Dendron
Home Page: https://wiki.dendron.so
License: MIT License
Getting started with Dendron
Home Page: https://wiki.dendron.so
License: MIT License
The Install button at the bottom of the page calls it a VS Code plugin and links to the marketplace.
I think it would make more sense to use the VS Code native terminology of Extension.
Add a Microsoft Outlook
section somewhere, such as [[dendron.user-guide.transferring.cook]]
, with the following:
When adding Dendron notes into emails, sent via Microsoft Outlook, the following steps need to be done in order to maintain formatting. This will help with Markdown tables, among other features:
- In Outlook: Add the `Attach File` button to the `New Email` ribbon
- In Dendron/VSCode: `Markdown: Open Preview to the Side` (or `Ctrl+K` then `V`)
- Save preview as HTML
- In Outlook: Click on the `Attach File` button
- Select the HTML file that was saved
- Click the arrow next to `Insert`, and change to `Insert as text`
- Click to attach
The above steps should result in importing the HTML version of your Dendron note into the body of the email.
The Extensions page on the Dendron Wiki should be updated.
The Dendron Snippet Maker extension is currently not included at all, either under "Bundled" or "Archived / Deprecated". As it is not bundled with Dendron, it is most likely deprecated and should be added underneath the latter heading. The Tag Search extension most likely falls under the same category.
Additionally, the content of "Other VS Code Extensions" is not displayed properly. The section only contains the error message: "Start anchor other-vscode-extensions not found".
Lastly, while the "Other VS Code Extensions" links to the Tips page, there are other recommended extensions scattered throughout the wiki. For example, the Markdown page recommends the Text Tables extension. These extensions should also be aggregated on the Extensions page.
Thank you.
https://wiki.dendron.so/notes/ba97866b-889f-4ac6-86e7-bb2d97f6e376/
Isn't the Dendron Markdown Preview Enhanced
outdated ?
Might well be that I misunderstood. I have no idea for a better sentence, unfortunately
No response
Follow-up to #333
Use tooling to enforce, and prevent conflicts with, a style guide.
We should look at something like Vale, and pair with pre-commit. This would help with a variety of things, but could start with one:
This may be something more like three separate issues:
pre-commit
application of Vale, and other project standards
pre-commit
codespell
or other solutionExamples to include:
next.js|NextJS|Next.js
markdown|Markdown
markdown based|Markdown-based
github|GitHub
github actions|GitHub Actions
linkedin|LinkedIn
vscode|VS Code
twitter|Twitter
dendron|Dendron
obsidian|Obsidian
json|JSON
jekyll|Jekyll
dendron cli|Dendron CLI
vim|Vim
pdf|PDF
css|CSS
obsidian|Obsidian
youtube|YouTube
svg|SVG
js|JS
scss|SCSS
dendron//|dendron://
cli|CLI
edge browser|Edge browser
react|React
emacs|Emacs
sublime text|Sublime Text
microsoft word|Microsoft Word
now a days|nowadays
vs code insider|VS Code Insider
elasticsearch|Elasticsearch
vscodium|VSCodium
evernote|Evernote
github flavored markdown|GitHub Flavored Markdown
facebook|Facebook
github pages|GitHub Pages
wikipedia|Wikipedia
dendron next|Dendron Next
seed membership|Seed membership
dendron markdown preview|Dendron Markdown Preview
discord|Discord
rfc|RFC
gitlab|GitLab
foam|Foam
roam|Roam
chrome|Chrome
firefox|Firefox
google|Google
gmail|Gmail
airtable|Airtable
Now that I think of the Vendir stuff, examples of it being used in another open source project salt-user-guide
:
I can see this style guide being something that exists in a standalone repo under the dendronhq
org, so that the style guide:
Newbie to dendron. Went thru tutorial. noticed that it's outdated. posted a question in discord and volunteer to PR it.
reply was to send a PR directly via Edit in GitHub link.
Cannot find.
https://discord.com/channels/717965437182410783/735365126227493004/902374533657411636
https://discord.com/channels/717965437182410783/735365126227493004/902381062875914261
https://discord.com/channels/717965437182410783/735365126227493004/902381259794292747
@ScriptAutomate asked me to write up this issue here
https://discord.com/channels/717965437182410783/735365126227493004/902386206413840435
https://wiki.dendron.so/notes/f83c1d87-eac0-48f3-a5cf-8a69989d8ec1/#mermaid-optional
NOTE: in order to publish diagrams, you'll need to enable mermaid in the config
in Dendron/Topics/Markdown
Section and value about mermaid in the config are removed.
Delete? I'm not sure.
Maybe it is already implemented but not documented:
I would like to builid more complex templates using list variables in the front matter and loop through them with golang template
or jinja like syntax. It would be nice to have more power there.
What dialect of templating are you using at the moment (would be nice to document)?
Thanks for this nice project!
Have you spotted a typo or general grammar problem? 📝 ✔️ You can reference this issue in your pull request to help us improve the quality of our site, without having to create a paired issue for the small fixes.
Is it possible to show interactive Graph View on dendron's public site?
I understand there's a discussion dendronhq/dendron#615 around this topic, but there could be something easily borrowed from D3.js https://observablehq.com/@d3/force-directed-graph.
It will make searching through the docs for new information easier. Currently, I have to review docs that I've already read just to make sure that something hasn't been added.
Win10
VSCode 1.47.2
Trying to run the command 'Dendron: Initialize Workspace' results in the following notification:
'Command 'Dendron: Initialize Workspace' resulted in an error (command 'dendron.initWS' not found)'
https://wiki.dendron.so/notes/f3a41725-c5e5-4851-a6ed-5f541054d409/
VSCode version 1.64 (January 2022) added an experimental "Explorer file nesting" feature. When enabled this can be used to group files under other files, giving a nested directory-like structure even to a flat directory.
It might be worth adding this to the documentation, I'm happy to do a PR for it but I don't know if (1) this fits with the approach of Dendron or if (2) adding experimental vscode features to the docs is a good idea.
This can be used to tidy up and collapse sections of the file view, for example this is what my daily notes look like with this enabled:
This is achieved by:
"explorer.experimental.fileNesting.patterns": {
"daily.journal.2022.*.md": "daily.journal.2022.$(capture).*.md"
},
"explorer.experimental.fileNesting.enabled": true,
$(capture)
refers to the content of the wildcard of the key. So this means that a file matching daily.journal.2022.*.md
will appear to be the parent of daily.journal.2022.$(capture).*.md
, e.g. for daily.journal.2022.01.md
, 01
is capture
, so daily.journal.2022.01.md
will be the parent of any files matching daily.journal.2022.01.*md
.
This should also work with deeply nested structures, so another rule can be made to group files together by the year.
Could also be done to group schemas together, something like "schemas.yml": "*.schema.yml"
would group together all schemas under a schemas.yml
file.
https://wiki.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47/#browse-note
The description of the command Browse Note cuts off mid sentense
Open the GitHub repository (if it exists) of the current note. If you have a [multi vault](https://wiki.dendron.so/notes/24b176f1-685d-44e1-a1b0-1704b1a92ca0) workspace with different git repositories, this command will
will... what?
When opening an anchor link e.g. https://wiki.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50/#stubs , the fixed search bar hides the first couple lines of the subheading. Illustrated in this article https://css-tricks.com/fixed-headers-and-jump-links-the-solution-is-scroll-margin-top/
Context: We recently launched a feature (dendronhq/dendron#2045) that had to be commented out because it broke frontmatter variable substitution. Since {{ fm.title }} is not a valid variable from lodash's point of view, it would need to a ReferenceError
Goal: Introduce direct variable replacement
Design decisions:
- What syntax should we adopt for this? eg. <%= =>
- Currently we use {{ }} for frontmatter substitution. This doesn't replace the contents of the note, but rather changes how it's displayed in the preview
- Should we use a different syntax for direct substitution (ie to replace note content)?
- Implementation wise, lodash supports js execution. should we support this as well?
- Additional feature that requires extra check (workspace trust)
I'm really enjoying Dendron so far, but as I start getting deeper into hierarchies, it gets cumbersome to write out the entire path as a backlink and then use the Go To
shortcut to create it. Is there a command to pre-populate the descendent branch or a better way of doing this workflow so I can just add the child note name and then create it?
I guess this is the same issue I reported on dendron-docs.
This is the markdown:
Check out an end-to-end workstyle, managing 20k notes, using schemas and daily journals from [[A Day in Dendron|dendron://dendron.dendron-site/community.greenhouse.2021-07-23-using-dendron-with-20k-notes]]
This is what gets rendered:
Check out an end-to-end workstyle, managing 20k notes, using schemas and daily journals from A Day in Dendron (Private)
https://wiki.dendron.so/notes/ZeC74FYVECsf9bpyngVMU/#removestubs
Stubs are defined as "Stubs are notes that don't exist but that you might want to create."
But the Dendron: Doctor command says it removes stubs... that makes no sense to me.
I see a couple possibilities:
A stub doc is any document with frontmatter but no other content
- which scares me and I would like to disable this option
or
A stub doc is any document with frontmatter, no other content, and no backlinks
this is what I am looking for
or
A stub doc is any document with no content
or
other?
No response
These tasks are remaining after work done for the initial site reorg, as discussed in dendronhq/dendron#1665
#todo
vault/dendron.user-guide.basics.md:19:- Journals #todo
vault/dendron.user-guide.editing.md:11:- Math and Diagrams #todo
vault/dendron.user-guide.extending.md:10:- Note Type System #todo
vault/dendron.user-guide.extending.md:12:- Custom Pods #todo
vault/dendron.user-guide.organizing.md:14: - Journals #todo
vault/dendron.user-guide.retrieving.md:14:- Search #todo
[[dendron._ref.terms]]
with [[dendron.concepts]]
[[dendron.user-guide]]
)
[[dendron.ref.cli]]
[[dendron.ref.config]]
[[community]]
For organizing, if you look at FAQ or CLI, they are either random or alphabetically ordered. We want to order them the same way we do our user guide
my project:
Can you teach me how to deploy in github pages , No domain name required
Can you give me github workflows
Or give an example
Typo on this page:
https://wiki.dendron.so/notes/678c77d9-ef2c-4537-97b5-64556d6337f1.html
In first sentence, of first paragraph, it currently reads:
Pre-requisites
This walkthrough will help you get started with Dendron. Before you start, make sure you the following:
Maybe it should say "make sure you do the following"?
https://wiki.dendron.so/notes/f2ed8639-a604-4a9d-b76c-41e205fb8713/#logo
I think the logo section may be out of date. I tried using logo
and that didn't work, but using logoPath
under publishing
did work for config v5.
I got this working example from the dendron.yml for the docs. The key is now logoPath
and located under publishing
.
Line 87 in fbc505a
Also, I think it would be helpful to explicitly state where in the config hierarchy certain keys are expected by providing a minimal example.
publishing:
logoPath: vault/assets/images/logo.png
https://wiki.dendron.so/notes/0fbg5vbv5jzb0623pbi4v3t/
I followed what's stated and it just doesn't do anything.
No response
typo in "topic/lookup/creating notes":
journal: create a journal note (cmd/ctrl + shift + s)
scratch: create a scratch note (cmd/ctrl + shift + j)
I think #lookup-shortcut-is-not-working is missing a keybinding override.
There are two <CTRL+L> keybindings that conflict with the dendron lookup command. One is built in and the other is installed with VSCodeVim.
I have no idea what the VSCodeVim shortcut does but have asked here.
Recently had to add the following URL prefixes/links due to failing URLs in the URL validator:
Need to follow-up and update the documentation if these have moved, or are temporarily down.
GitHub doesn't like all the calls that brok
is doing against it, and brok
doesn't have much support for customizing output around particular status returns. I'm going to add it to .brokignore
for now so that this PR passes without the 429 failures, as I'd like to suppress 429 failures since they aren't the same as 404, etc.
I'm going to make a follow-up issue that could enhance the URL validator approach, in the future, with some starter commands that I'd have to experiment with at a later date. This approach would allow for internal links as well as external links, and would ensure that the site can build without errors. It seemed like using blc
, or other npm
based tool would be more forward thinking in case anything like dendron-cli
would be extended to make use of the package (or similar package).
# container
# node:14-bullseye-slim
npm install broken-link-checker
npm install serve
npm install @dendronhq/dendron-cli@latest
npm install @dendronhq/dendron-11ty@latest
npx dendron-cli buildSiteV2 --wsRoot . --stage prod
npx serve 2>> /dev/null &
blc http://localhost:5000/notes -ro --exclude-internal > output-internal.log
blc http://localhost:5000/notes -ro --exclude-external > output-external.log
Originally posted by @ScriptAutomate in #179 (comment)
There is a broken link at the https://github.com/dendronhq/dendron-site/blob/master/vault/dendron.features.md
You can read this blog post for the extended rationale behind this.
this blog post
leads to https://kevinslin.com/organizing/its_not_you_its_your_knowledge_base/ which returns an XML with a message The specified key does not exist
https://wiki.dendron.so/notes/F5ly88oU0ecUiACLxET5E/
Hi:
It looks like this is everywhere at the Documentation wiki. I've referenced the URL above because it's easy to see the problem there.
In the content pane, no matter where I hover, the same URL will be fetched.
It's as if the entire content is wrapped in an tag.
Using Firefox's inspector, it looks like this pattern might be the problem?
Using Firefox's Inspector and removing all of those tags, it looks hovering over a link now shows the proper URL.
In any case, links are not working there at all.
I apologize for the vagueness of this report. The problem is everywhere at the documentation that I've looked, and it should be pretty obvious for anybody trying to use it (using Firefox).
The screenshot shows the FF Inspector. Note that that no matter where the pointer moves in the highlighted area, the URL stays the same.
Again, sorry for the vagueness here. Please let me know if I can clear anything up.
This doesn't appear to be happening with Chrome.
Maybe clobber the svg tag referenced?
This is an extension of the conversation in the dendronhq/dendron
repo:
I've been trying to figure out the new way of using reference notes, which was mentioned in a recent PR of mine (#60), as I was still using the old way. Detailed here is the newer way:
I didn't realize there was some cool new ways of working with note references via ![[foo]]
instead of ((ref: [[foo]]))
, but I am struggling with the actual implementation.
This format gets rendered as plain text, and isn't picked up by Dendron at build at all:
![[ dendron.community.showcase
#Open AWS Catalogue,1
:#*
]]
Trying to condense together at least gets rendered, but doesn't work as expected:
![[dendron.community.showcase#Open AWS Catalogue,1:#*]]
I get the on-page rendered error of: Start anchor Open AWS Catalogue not found
(but it does exist!)
The old format still works:
((ref:[[dendron.community.showcase]]#Open AWS Catalogue,1:#*]]))
After playing around, I realized the new format works only when there is no whitespace in a header reference, and the whitespace is replaced with a -
. This means that this rendered properly for the Open AWS Catalogue
header:
![[dendron.community.showcase#Open-AWS-Catalogue,1:#*]]
@kevinslin said the following in dendronhq/dendron#530 (comment):
we need to update the docs. the new style note refs use github style slugging
this is because old note refs weren't able to handle special characters in the headers
tldr: whitespace is no longer supported because github-slugger doesn't support it. if you use thecmd+shift+r
shortcut on a header, we will automatically sluggify the note ref
A small quibble, but reading through the guide, I believe there is inconsistent capitalization of some proper nouns:
dendron/Dendron
vscode/VSCode/VS Code (see https://code.visualstudio.com/)
markdown/Markdown (example usage)
vim/Vim
emacs/Emacs
sublime/Sublime (or canonically Sublime Text)
https://github.com/kevinslin/schemas
https://github.com/dendronhq/schema-library/tree/main/vault
See the search results for schema-library
: https://github.com/dendronhq/dendron-site/search?q=schema-library
See the search results for kevinslin/schemas
: https://github.com/dendronhq/dendron-site/search?q=kevinslin%2Fschemas
Are they meant to be the same or different? and under what circumstances? for a newbie who want to use schemas in their own workspace, what is an ideal example?
The following line points to documentation that doesn't exists anymore.
The anchor #can-i-customize-the-markdown-preview-css
seems to no longer exist.
When I enter "Dendron: Initialize Workspace" in the command bar, I get the following error:
Command 'Dendron: Change Workspace' resulted in an error (command 'dendron.changeWS' not found)
Other commands appear to do the same thing.
#310 makes the Publish CLI page confusing as if an npx one-liner would work without context in the referenced page.
npx
would not know that dendron
is from @dendronhq/dendron-cli if it's not installed.
The footer at the "homepage" i.e. the site found when searching on major search engines, i.e. www.dendron.so, says:
©Dendron INC 2020
It links to https://www.dendron.so/#
I think,
a) it should have either the current year or a year range (i.e. from invention/first commit to current year, such as 2020-2023)
b) if there is a Dendron Inc., it should link to the page of this company...
Dunno, if this is the right repo to raise the issue, so please feel free to distribute.
Best wishes,
Karsten
Line 12 of the links page ( https://github.com/dendronhq/dendron-site/edit/master/vault/dendron.tutorial.links.md ) has two consecutive back-quotes before the [[ that do not appear to be necessary. I am not sufficiently confident of this to submit a PR, however.
https://wiki.dendron.so/notes/ffec2853-c0e0-4165-a368-339db12c8e4b/
There's quite a few flags/values that could be useful for publishing that are specified per-note, e.g. the nav_exclude flag which is used within dendron site itself (https://github.com/dendronhq/dendron-site/blob/master/vault/dendron.topic.md ) but these are only documented (at least where I can find) in the legacy publish pages instead of in the new ones.
It would be good to have all relevant front-matter listed within the current publishing notes.
I'm not sure if it should be based in here or somewhere else? https://wiki.dendron.so/notes/fabYbPyk3DMCMoG92lIrq/
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.