runlevelrobot
11/07/2020, 7:54 PMtfer
11/07/2020, 9:44 PMdendron-template
on github, (maybe dendron-site-template
would have communicated the repo's intent better, I found the name a little cryptic). Looking around the repo I see two copies of the notes, one with dot-hierarchical names in the vault, and one with the universal-ID naming style under the docs/notes/ directory.
I guessing the notes in the vault are the ones we edit in vscode, while the ones in docs/notes/ are generated as a step in creating the static files for a jekyl site, is that correct?
- are these updated as we make edits or only ever up dated when generated for the next iteration of the site?
- if the later does the update work on changed/added files only, or does it wipe and generate anew?
- are these files even needed or could you empty the docs/notes/ directory?
Some renaming of the directory structure from conventions used in sphinx might make things clearer and make a place for enhancements (pod outputs?). Instead of docs/notes use builds/
, then place the generated files in two level subfolders. Where the first level is named for generator-purpose, the second level names the type of output, prefaced with an underscore, (indicating the file in this directory are are generated, and may be overwritten when the generator is invoked again.
e.g.
builds
- dendron-ID-renamer
_IDs-md
- jekyl
_static-site-files
- sphinx
_html
_pdf
- pandoc
_md
_html
_pdflukecarrier
11/08/2020, 11:45 AMdendron-template
on github, (maybe dendron-site-template
would have communicated the repo's intent better, I found the name a little cryptic).
This is helpful feedback, thanks. Can you remember where you were directed to the dendron-template
repo? The getting started docs suggest initialising an empty workspace from within VS Code:
https://www.dendron.so/notes/d95b93bf-5e6f-4dd0-b7d7-c8e29e061876.html#install
> the notes in the vault are the ones we edit in vscode, while the ones in docs/notes/ are generated
Yep! The filenames in that directory match the id
values in the frontmatter (between the ---
) at the top of the markdown files.
> - are these updated as we make edits or only ever up dated when generated for the next iteration of the site?
They're updated whenever you run the "Dendron: Build pod" command. The relevant docs look a little sparse right now, but here they are:
https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#pods
> - if the later does the update work on changed/added files only, or does it wipe and generate anew?
Incremental update support requires rsync
for now, but it can be enabled:
https://www.dendron.so/notes/401c5889-20ae-4b3a-8468-269def4b4865.html#incremental-builds
https://discordapp.com/channels/717965437182410783/739186036495876126/759169016333336596
> - are these files even needed or could you empty the docs/notes/ directory?
They're not necessary for Dendron to work properly, they're just for publishing.
> Some renaming of the directory structure from conventions used in sphinx might make things clearer and make a place for enhancements (pod outputs?).
I'm not sure there's been much discussion around this yet. Dendron is getting support for multiple vaults (root directories for notes) soon, so that may be an ideal opportunity to rethink the directory structure.
@User hope this 👆 helps, thanks for the thoughtful feedback and welcome to Dendron 😊tfer
11/08/2020, 4:52 PMlukecarrier
11/08/2020, 4:59 PMkevins8
11/08/2020, 4:59 PMtfer
11/08/2020, 6:12 PMdendron-template
repo?
I wasn't directed there, I set up the fork so I can summit PR's on the documentation on on things I've found as I'm working through Dendron.
One of my use cases for dendron is to help me revamp the doc for a opensource project I contribute to, (Leo Editor - written in Python), so I'm exploring dendron with an eye towards that end.
As I don't know all the nuts and bolts of markdown, and Leo's doc is too complex to just wade in and start there with out a plan, I'm practicing by making a set of notes for Markdown from resources on the web, e.g. https://github.com/mattcone/markdown-guide
This is giving me a chance to practice the "Amoeba technique", as a lot of the stuff I'm finding are monolithic pages, adapt the markdown source to how dendron uses markdown, and so on.
Some of the principles that guide me in rewriting doc:
- rename things to make what they represent as obvious as possible
- watch out for things that break existing conventions
The first informs the proposed renaming of dendron-template
, delving into it I see that Kevin8 use of template is as the dendron web site, dendron-site-template
, or even denron.so-site-template
make the repo's use more apparent.
I haven't got to the point where I'm ready to publish/host things, so my questions in the post where just to see if my intuitions about this must work were right or not. Going by the structure of other projects, docs/
, is were I was expect to find doc on the project, which is not what kevin8 is doing here, hence the proposed directory layout.
Perhaps Pod's should create/update a pod-log.md
file along with the other files to write timestamps and files updated, (when use the rsync version). `aside: `I never notice that git clone
clobbers creation dates.kevins8
11/08/2020, 8:23 PMdendron-template
was because in the early days, it was originally meant to be used for folks who wanted to setup a dendron vault via github. we eventually settled on using > Dendron: Initialize Workspace
instead and cloning the dendron-template
during initialization. it probably does make sense to rename it to dendron-site
or something equivalent today
> docs/, is were I was expect to find doc on the project
the reason why docs/
is the publication folder is because that is the convention that was established by github pages (eg. auto-publication by branch or by contents inside the docs/
folder). docs/
in this case is for the published docstfer
11/08/2020, 8:35 PMdocs/
is the publication folder is because that is the convention that was established by github pages (eg. auto-publication by branch or by contents inside the docs/
folder). docs/
in this case is for the published docs
@User
Of course one of the problems with conventions is that you have to know them 😊 !
I might still argue for some of what I was talking about in the future as other targets than jekly become possible.kevins8
11/08/2020, 8:45 PMkevins8
11/08/2020, 8:45 PMdendron-template
since the name is misleading at this point 😅Konrad
11/09/2020, 4:31 AMkevins8
11/09/2020, 4:33 AMkevins8
11/09/2020, 4:34 AMgotcha
under pro.x.*
kevins8
11/09/2020, 4:35 AMKonrad
11/09/2020, 4:38 AMzenen
11/09/2020, 9:28 PMkevins8
11/09/2020, 9:37 PMzenen
11/09/2020, 10:14 PManochvay
11/10/2020, 7:15 AMU de Recife
11/10/2020, 10:18 AMU de Recife
11/10/2020, 10:18 AMnsb7
11/10/2020, 10:22 AMnsb7
11/10/2020, 10:24 AMU de Recife
11/10/2020, 10:30 AMU de Recife
11/10/2020, 10:31 AMprojects.diy.template.md
Not
projects.template.diy.md
U de Recife
11/10/2020, 10:32 AMtemplate.md
.U de Recife
11/10/2020, 10:33 AMnsb7
11/10/2020, 10:34 AMnsb7
11/10/2020, 10:35 AM