oleeskild / obsidian-digital-garden Goto Github PK
View Code? Open in Web Editor NEWLicense: MIT License
License: MIT License
Hello, @oleeskild.
I've found your plugin very useful for publishing notes to Github pages. There were many attempts to make fully featured analogue to obsidian publish. For example:
Most of them share one common thing: _notes
folder as main for site. But none of them, done publishing from Obsidian. π
May be we can customize plugin to support other templates?
Things to make it happen:
This markdown (subitems are indented with 4 spaces as per more traditional markdown specs):
- [ ] item1
- [ ] item2
- [ ] item with a sublist
- [ ] subitem1
- [ ] subitem2
- [ ] subitem3
- [ ] itemN
...correctly generates this html:
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" id="cbx_12" disabled="true"><label for="cbx_12"> item1</label></li>
<li class="task-list-item"><input type="checkbox" id="cbx_13" disabled="true"><label for="cbx_13"> item2</label></li>
<li class="task-list-item"><input type="checkbox" id="cbx_14" disabled="true"><label for="cbx_14"> item with a sublist</label>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" id="cbx_15" disabled="true"><label for="cbx_15"> subitem1</label></li>
<li class="task-list-item"><input type="checkbox" id="cbx_16" disabled="true"><label for="cbx_16"> subitem2</label></li>
<li class="task-list-item"><input type="checkbox" id="cbx_17" disabled="true"><label for="cbx_17"> subitem3</label></li>
</ul>
</li>
<li class="task-list-item"><input type="checkbox" id="cbx_18" disabled="true"><label for="cbx_18"> itemN</label></li>
</ul>
I created a excalidraw with 2 pictures but found it failed to render properly. If I delete the 2 pictures, and it renders correctly.
An example is given on excalidraw test. As you can see, the first one renders well, but the second one (only add 2 pictures to the first one) fails to display. It seems that the markdown view of the second excalidraw is rendered. In obsidian, it is shown below.
Also, I find if I add a link in the excalidraw, it may also fail to render properly.
If you need any more information, please tell me and I will try to provide all I can. Thank you!
Hello !
I try to push using mobile (IOS - Iphone) but nothing seems to work : I have no notice and nothing appear on the github.
Also, I work on a "seems of" fork of your project, using my own solution (obs2mk, a python script used as a Github Actions). You can check it out if you want !
https://github.com/Mara-Li/obsidian-mkdocs-publication
This plugin doesn't work too with mobile :(
If I have note A which contains a note to [[abc]]
, then note B which contains a transclusion of note A (![[A]]
), then the link fails to render as HTML and doesn't become clickable. I'm not entirely sure which versions are affected, however I do recall my links working earlier.
If it's of any use, here's my notes site which demonstrates this issue.
This is a feature request.
Looking at your demo url, I wonder if you can make an option in the plugin to replace 'space' by hyphen '-' instead of '%20', and all lowercase.
Or even better if I can assign a key in frontmatter to define a slug for specific notes, while the rest will be generated automatically by default based on filename.
https://ole.dev/notes/Set%20up%20your%20own%20digital%20garden
Unable to publish a note using obsidian mobile (insider build).
Everything is configured correctly :
Is the plugin compatible with mobile ? If not, please change your manifest to set true
in isDesktopOnly
In some countries it is required to add an imprint and data policy to every webpage. Could you implement an option for it? I think it would be enough to have the option to set a md file for imprint and data policy and simple link them inside the page footer.
Transclusion to part of the note aren't supported and show full note instead, so syntax like:
Do you think you can support it? I use transclusions a lot and without that feature it's hard for me to share my notes.
Hi. Thank you for your work, this is the easiest, most convenient and easily customizable way to publish your notes that I have tried.
Is it possible in the future to make support for other YAML attributes together with the attributes for publishing? Something like this:
---
dg-publish: true
date: 2022.03.12
time: 19:58
aliases: []
tags: []
---
Right now if I try to publish a note with such metadata, I get errors in the deployment log.
Hi, I was wondering what the end result looks like for this plugin but can't find any other sample pages. If you know of anyone who uses this plugin to publish their notes could you please share their pages here? Thanks a lot!
Thank you for your cool product! Any ideas how to add search widget?
If the first line of a transcluded Obsidian note is a heading, then Obsidian Digital Garden seems to render it as "# Heading" rather than as an HTML
Not sure what I'm doing wrong. I can publish the home page, but when I try to link to other pages on the home page, they all resolve to this message:
And my homepage looks like this, with odd link names I can't seem to control:
Have I done something wrong? Is there a way to fix this issue?
Thank you!
Currently, MathJax syntax between $dollar signs$
and $$double dollar signs$$
do not work, meaning mathematical expressions do not render correctly. Support for this would be awesome!
Sidenote: Would you prefer for issues to be opened here, or at the template repository?
It would be handy to have a way to setup a directory where all notes inside it (and in its subdirs) are meant to be published.
The first thought I had was "having a directory where every note has dg-publish: true
", but maybe the maintainer has a better idea to implement this.
Plugin has become unuseable. Does not display files uploaded or removed. Lags badly, and upon waiting too long makes everything on my Obsidian disappear. Upon restarting my obsidian view returns, however i have to quickly turn off the plugin. I'm not sure this isn't by my own fault. Recently i installed Breadcrumbs and that seemed to not play well with the metadata this plugin was reading. I'm not sure if that is the reason this started happening or not. After uninstalling that breadcrumbs and removing all of that metadata to my knowledge, this is still happening.
Hi there,
I have a use case in which it would be great, if Excalidraw-Files (in .md files, that means with front matter) could be directly rendered and published. Unfortunatly I don't have a good idea about how to do this, becausr I'm not too deep into the inner workings of the excalidraw plugin. It would be great if this would work:
Right now I auto-export .png from Excalidraw, generate a new note, embed the .png and add dg-publish: true to that file.
Thanks for your great plugin, BTW!
This is very much a "wishlist" feature request, but it would be useful for Digital Garden notes to have an RSS feed, so interested parties can get updates to the garden. I realize something like this brings up related questions, like: does the RSS feed automatically show subscribers updates to notes, and should it do so even if those updates are truly minor (like correcting a small typo). Or should note YAML control this, etc?
Anyway, just wanted to suggest RSS feeds as a feature.
I was wondering if a sidebar support was possible, for easier navigation.
I tried your brilliant plugin, it works so amazingly. Thank you!
And I have an natural idea. In the homepage (the note with dg-home: true) I use the dataview plugin to list all the notes published. But the dataview seems not be supported. It is shown below.
I know that the current support content does not include dataview, but I truly hope this could be realized. If supporting dataview costs a lot of time, just ignore my issue. Because this plugin is good enough already.
I'm migrating a bunch of notes from an old vault to my new digital garden. I published them and noticed in the repository's commit history that each single note were added in an individual commit (example here).
From the end-user point of view it's insignificant. But as developer, seeing that it triggered a bunch of events on netlify makes me feel like a wasted use of (free) resources.
I'm not a JavaScript/TypeScript person and I'm not sure about the amount of coding effort to parse all files and group them in a single git commit.
Feel free to close this issue if such behavior is like that "by design".
It would be good if we could allow all front matter to pass through to the templatng system, that way you could use things like dates and last mod times in templates to show update time periods, or any other arbitrary front matter. You could probably also take advantage of collections in eleventy and tags in obsidian. Simply allowing whatever front matter that exists in obsidian to pass through is a good first step though.
Hello, I just find a little bug in rendering the inline codes in Admonitions.
For example of the below admonition, It renders like this.
The inline code Eigen
was rendered as a total line. But the code blocks in admonitions are rendered correctly.
`Eigen` renders falsely.
~~~cpp
`Eigen` in code block render fails.
~~~
Also, the admonition is officially supported as "callout" by Obsidian. It seems that the plugin does not support the callout at this time. But currently I think the admonition is good enough, and it may take a lot of time to support the callout.
Thank you for this digital garden!
Two questions that I had:
Thanks in advance.
Looks like everything inside a pair of %%
symbols (in md file) gets excluded
It wouldn't be such a big problem if only the code blocks were not affected as well,
and the escape symbol is not functional inside them unfortunately, this crushes a lot of things
this piece is for instance:
for %%x in (%*) do (
set /A argCount+=1
set "argVec[!argCount!]=%%~x"
set "argVn[!argCount!]=%%~nx"
everything after for
and before the ~x
gets lost
and then a huge part of md is also excluded until the next pair of %%
is found somewhere in the other code block
I would like to see same transform as a excalidraw. But currently is not supported by dataview, see blacksmithgu/obsidian-dataview#42.
Testing on ipad.
Enabling the plugin transform all text in settings in red.
In think there is a error in the plugin CSS.
Hello! I know I can use ![[Some Other Note|{{title}}]] in my transclusion source, but I find it troublesome. Couldn't we have an option in plugin options to change this behaviour for all published notes?
main.js has file extension main.ts in the zip
Not a biggy...
When I update the theme without changing the favicon, the plugin creates an empty commit for the favicon.
The maintainer already replied about this topic here: #29 (comment)
I'm opening this issue just to help to remember.
To reproduce:
@inbox\test.md
with an image ![](XXXXXX.png)
@assets\XXXXXX.png
for my case.src/site/notes/
, while the image file is missing. Plus, there is not even a link of the image in the page file, which seems to be filtered out.Is it a bug here?
Because the images are base-64 encoded, if you include too many images on a page, you might unintentionally cross the boundary that the GitHub API seems to allow. Here are the errors in the console I got when trying to publish a note that included a lot of pictures:
Not sure what the right fix is for this. Should images be linked instead of encoded? Tough to tell.
What happend:
The page published(With Copy Garden URL commandοΌ: https://note.imfan.net/work/the-test-page-of-digital-garden-test/
The full title: The test page of digital garden δΈζι‘΅ι’ test
Didn't test other non-english alphabet content, but can confirm the Chinese won't work.
3:58:35 PM: <--- Last few GCs --->
3:58:35 PM: [1307:0x5b527b0] 32119 ms: Mark-sweep (reduce) 2048.1 (2056.8) -> 2047.7 (2056.8) MB, 3.5 / 0.0 ms (+ 15.7 ms in 6 steps since start of marking, biggest step 15.4 ms, walltime since start of marking 29 ms) (average mu = 0.571, current mu = 0.474) fina
3:58:35 PM: <--- JS stacktrace --->
3:58:35 PM: FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
3:58:38 PM: Failed during stage 'building site': Build script returned non-zero exit code: 2 (https://ntl.fyi/exit-code-2)
3:58:35 PM: 1: 0xb09980 node::Abort() [node]
3:58:35 PM: 2: 0xa1c235 node::FatalError(char const*, char const*) [node]
3:58:35 PM: 3: 0xcf784e v8::Utils::ReportOOMFailure(v8::internal::Isolate*, char const*, bool) [node]
3:58:36 PM: 4: 0xcf7bc7 v8::internal::V8::FatalProcessOutOfMemory(v8::internal::Isolate*, char const*, bool) [node]
3:58:36 PM: 5: 0xeaf465 [node]
3:58:36 PM: 6: 0xebf12d v8::internal::Heap::CollectGarbage(v8::internal::AllocationSpace, v8::internal::GarbageCollectionReason, v8::GCCallbackFlags) [node]
3:58:36 PM: 7: 0xec1da5 v8::internal::Heap::HandleGCRequest() [node]
3:58:36 PM: 8: 0xe4f447 v8::internal::StackGuard::HandleInterrupts() [node]
3:58:36 PM: 9: 0x11fb805 v8::internal::Runtime_StackGuard(int, unsigned long*, v8::internal::Isolate*) [node]
3:58:36 PM: 10: 0x15f0b19 [node]
3:58:37 PM: ERROR: "build:eleventy" exited with 1.
3:58:37 PM: β
3:58:37 PM: ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
3:58:37 PM: "build.command" failed
3:58:37 PM: ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
3:58:37 PM: β
3:58:37 PM: Error message
3:58:37 PM: Command failed with exit code 1: npm install && npm run build (https://ntl.fyi/exit-code-1)
3:58:37 PM: β
3:58:37 PM: Error location
3:58:37 PM: In build.command from netlify.toml:
3:58:37 PM: npm install && npm run build
3:58:37 PM: β
3:58:37 PM: Resolved config
3:58:37 PM: build:
3:58:37 PM: command: npm install && npm run build
3:58:37 PM: commandOrigin: config
3:58:37 PM: publish: /opt/build/repo/dist
3:58:37 PM: publishOrigin: config
3:58:37 PM: redirects:
3:58:37 PM: - from: /*
status: 404
to: /404
redirectsOrigin: config
Caching artifacts
3:58:37 PM: Started saving node modules
3:58:37 PM: Finished saving node modules
3:58:37 PM: Started saving build plugins
3:58:37 PM: Finished saving build plugins
3:58:37 PM: Started saving pip cache
3:58:37 PM: Finished saving pip cache
3:58:37 PM: Started saving emacs cask dependencies
3:58:37 PM: Finished saving emacs cask dependencies
3:58:37 PM: Started saving maven dependencies
3:58:37 PM: Finished saving maven dependencies
3:58:37 PM: Started saving boot dependencies
3:58:37 PM: Finished saving boot dependencies
3:58:37 PM: Started saving rust rustup cache
3:58:37 PM: Finished saving rust rustup cache
3:58:37 PM: Started saving go dependencies
3:58:37 PM: Finished saving go dependencies
3:58:37 PM: Build failed due to a user error: Build script returned non-zero exit code: 2
3:58:38 PM: Failing build: Failed to build site
3:58:38 PM: Finished processing build request in 56.564902757s
I tried to update my digital garden for a few times the past few days, but I doesn't update the changes for me. I don't really understand the problem here. Can someone help me please? Thanks!
I think the plugin is good enough to use, and so, I pay more attention to the details.
The favicon of the current pages is the default one. You can see my page to check out. IMO, this is a little tedious. But I searched the plugin and template repos, and it turned out that both repos don't include any "favicon" codes.
I would thank a lot if you could spare some time to implement a function for customizing the favicon. Thank you for your great work.
When entering field matter for dg-permalink, file fails to push to git. Also, strangely, when viewing published notes from the dg publication center, all published note information disappears. Removing dg-permalink and field matter restores the information.
Hello guys!
Firstly: Awesome plug-in! β€οΈ This was exactly what I was looking for. π
βΉοΈ Regarding my issue:
I would like to automatically create a list of all notes in a specific folder (i.e. list of internal links). To avoid linking each file separately.
I solved this using dataview and the following query: dataview list from "21 Homepage Wordpress"
which displays the list of links just fine in Obsidian.
β Problem: Please visit www.alberer.contact in the middle of the page you will find the following section:
But of couse instead of list from "21 Homepage Wordpress"
I would like links to notes of above specified folder to appear.
Did I do something wrong or can this dataview query just not be rendered correctly with dg?
(If so, do you have a solution?)
Thanks!
I'm using highlighting and footnotes on my notes and it seems the features aren't supported.
It looks like the highlighting feature isn't supported in GitHub neither, but the footnotes seem working partially.
Use two equal signs to ==highlight text==.
Use two equal signs to ==highlight text==.
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: meaningful!
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
Here's a simple footnote,1 and here's a longer one.2
You can also use inline footnotes. ^[notice that the carat goes outside of the brackets on this one.]
Hello! Thank you a lot for your plugin!
I just wanted to ask if there is a way to mark empty links on the site (by color, for example)? If not, is it possible to make such a function? This would be very useful, because for privacy reasons, it is often necessary to publish only certain notes. And it is quite problematic to delete on each note links to other notes that you are not planning to publish. If you could help with this problem (or suggest how it is possible to solve it by myself), I would be very grateful to you!
Just like the graph view on Obsidian as shown below, there should be a way to export it (and even if it isn't dynamic), it will be a nice touch to the digital garden.
Thanks.
The admonitions and callouts which look like this: > [!ABSTRACT]
and ad-tldr
would be quite aesthetically appealing and useful on the digital garden.
Thanks!
In Obsidian the following gets rendered when a reference to a heading in a note specified:
The plugin output produces the following (I've updated some CSS stylings on my site):
and the link points to:
/notes/sanitaer-und-heizungsplanung-heizungssystem
This should be:
/notes/sanitaer-und-heizungsplanung/#heizungssystem
And an <a id="heading name">
is missing on the headings.
Hello, I am requesting a feature which includes support for Style Settings, a plugin frequently used with popular themes such as Prism.
This would make customization of the digital garden seamless.
Thanks!
When you have folders and you publish files with the same file name in it one of the two files get's replaced by the other file.
You can work around this issue by naming the files differently, but it would be very convenient to allow files with the same names.
Hi - I moved my garden home note into another folder. Now content on that page has doubled up. If I move the note to a third location I get duplication of the content again - tripled up.
V2.4.0 of the plugin on latest Obsidian.
Any ideas?
Thanks.
Thanks so much for fixing the SVG image support, but the resizing tag like ![[img.svg|256]]
or ![img|256](img.svg)
isn't currently working with SVGs
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.