obsidianmd / obsidian-help Goto Github PK
View Code? Open in Web Editor NEWHelp documentation for Obsidian.
Home Page: https://help.obsidian.md
Help documentation for Obsidian.
Home Page: https://help.obsidian.md
In help system the only name you can find is Internal link . If you search help for Wikilink
you will get zero results.
From the other hand, corresponding Obsidian option calls them Wikilinks
And community calls them Wikilinks
most of the time.
I suggest Wikilinks
alias to be added as a synonym to the help documentation.
NOTE: Initially created the same issue on the forum https://forum.obsidian.md/t/wikilink-in-help-documentation/36818
A tiny thing, but I'm curious as to whether there's a reason for the non-alphabetical order in "Current list of core plugins"? I feel it would be easier to read of alphabetical.
I would love kick off the German documentation translation and then improve it in a second and third run with a team of German Obsidian users (I have seen in the forum that there might be quite a few)
see also obsidianmd/obsidian-translations#568
Please consider adding a reference link and internal reference link examples to "format your notes.md"
For example:
[Obsidian][1]
[internal link example 1][2]
[internal link example 2][3]
[1]: http://www.obsidian.md
[2]: obsidian://open?path=D:%2FPATH%2FTO%2FFILE.md
[3]: obsidian://open?vault=MainVault&file=MyNote.md
Using custom JavaScript on Publish requires the use of a custom domain.
As someone relatively new to Obsidian, I have really struggled with knowing how to name the different parts of the program, to ask for help.
Lots of explanations seem to come in terms of technical implementation details, rather than things visible to users.
I recently discovered that the online Help does have quite good descriptions of the areas of the program.
But none of the sections has any images to show what they are talking about - which means people need to read the words to understand...
I really think these pages marked in red would be significantly more useful if there were small screenshots showing the relevant area of the UI...
Hi @ericaxu Would you like a hand with this? I would be happy to spend some time creating the images and tweaking the content, if I could be confident there was interest in it...
I started working on Italian translation. I'll keep track of progress here.
In case someone would like to help, let me know to avoid double work 😉
Hi, the English Help has difference between GitHub's files and current Obsidian's application folder files.
Justy for example, descriprion of URI's Actions new
and hook-get-address
were missed in v0.11.10, in Using obsidian URI.md
file.
Which version of the Help is recommended for translation? GitHub's files or Obsidian's local Help files?
Thanks!
In the Format your Notes section of the documentation I missed the mention of horizontal rules.
***
or ---
or ___
format to:
tables need |(pipe) at the start of a line, and separated by minus-(not hyphen–,option minus in Mac)
Hi, is there any online page for other languages? I've dug out some while in publish.obsidian.md but found nothing. 🤔️
Or it just can read in this repo which would break obsidian's link.
Thanks for the works!
Changes to editing have recently changed. I noticed that after the installation of version: 1.1.0 (38), the following differences were found.
I consider the above 3 behaviors "bugs." However they may have been intended changes. But they are making me way less efficient. Not just because it's different. But because it takes a lot longer. Note I do all of my data entry using my phone. I have and Android Pixel 6 Pro running Windows 12. I'm using Microsoft SwiftKey. I'm hoping that the three above behaviors we're just oversights that were missed after a code rewrite. If these two behaviors could be regressed, I would greatly appreciate it.
Related: #269
From maintaining the hub's links to docs on core plugins, I noticed that:
This URL does not work:2.
https://help.obsidian.md/Plugins/Slash+commands
Yet weirdly, it did exist at some point:
https://github.com/obsidianmd/obsidian-docs/pull/242/files
The individual file size limit (100MB) for Sync should be added.
I didn't make a PR because the docs are being reworked.
Seems not to have been updated since release of Danish docs?
But would be nice with updated docs : )
But please include latest pull request :)
From maintaining the hub's links to docs on core plugins, I noticed that this URL does not exist:
https://help.obsidian.md/Plugins/Editor+status
Which appears to be known:
https://help.obsidian.md/Plugins/Core+plugins
Just noting it here, In case it's not on anyone's list. Thanks...
Hi!
I have translated the documentation of Obsidian's plugin to Chinese and this is my repo.
I hope that helps~ 😃
In the docs, I can only see...
Regular expressions (regex) can now be used in search.
It would be nice to see more information about what flavor of regex is actually supported.
For Chinese users, when using the input method, there will be problems at the line feed. The window of the input method will pop up and run to the top, and then it will get stuck.
for example,text in obsidian:
你好你好你好,你好你好你好【a】 (Line Break)
if i type something at 【a】 position on top,Especially some long phrases in Pinyin input method,If the input phrase is relatively long and there is a cross line, then the input method will lose focus, the input box will disappear, and then get stuck. Sometimes it is necessary to restart the app.
This problem has plagued me for a long time. Updating the app can't solve it, so that I now paste it into the software after entering text in the memo.
I recorded a video at bottom.
Thx, I like Obsidian very much.
—-
Hello,
I propose to create site for Russian version of the Help (like https://publish.obsidian.md/help-ru).
Thanks.
Hello!
I wanted to buy a catalyst tier and was unsure which one to pick. I wondered, if I pick the lowest tier if I'd need to pay the full price of the middle tier again in case I want to upgrade. Discord came to my rescue and answered that question for me :)
I think it's worthwhile to note this information in the documentation as well, in case somebody has the same doubts. I'll open a PR with a proposal shortly.
Some info, including a disclaimer that Sync is not for backup purposes, were lost during this restructure: #200
Some info including setting up Google Analytics were lost during this refactor: #203
Please try to recover them and put them in an appropriate place if possible.
Each callout has a different icon and colour, would be nice to display those in the docs maybe. Just a suggestion
Thank you for published version! 😉
One thing needs to be fixed - the Title:
обсидиан русская помощь --> Obsidian Русская Справка
Thank you!
Hi, Silver and other translators.
I'm planning to hold an online workshop with some Japanese users to warm up Japanese community. At the workshop or any other media such as Youtube video, I would like to use Japanese help docs to explain Obsidian usage and help docs itself, which is so huge. I don't know whether I can do it. I think I need a permission from you. So, please tell me about conditions or policies. I'll follow them. If this kind of thing is not allowed, I don't use.
Thanks.
Hello,
I propose to update Help sites for English and Russian, and maybe for other languages, if need.
As I can see, some published notes are outdated and don't match the latest GitHub versions.
Thanks.
This isn’t an issue directly but this felt like the most appropriate place to place this. I’m currently working on a full translation of the docs into Spanish. As I expect it to be something that takes a couple of weeks at my current pace I figured mentioning it here would be good just in case anyone else decided to do the same so we could work together instead of duplicating efforts.
Just to be clear I’m not asking for help as I’m fine to go through it all myself but I just want to avoid submitting a PR just to find out someone was doing the exact same thing and instead of working together we end up stepping on each other’s toes.
I am curious about the preferred way that I submit PR’s for this. I was planning on going through and doing a full translation and then submitting it in one PR all together. (The spanish branch on my fork will get updates as I go along) But if it is preferable to have multiple PRs with smaller chunks then I can do that.
I was also thinking it would be nice to have a section in the README to help track changes for languages that are fully translated. My thoughts on how this would work would be a section for each language that was completed and people could add that they have validated the language docs to be at parity with the English docs at a specific commit so I could periodically do a diff since that commit on the English doc changes folder and see what changes need to be ported to the language to keep the docs up to date. Git tags was another way I thought this might be able to work but I figured a section in plain text is a lot easier to manage with PRs and metadata like who verified the docs and maybe a date or something could be useful.
Is this a section that would be OK to add to the when I finish the translation or am I missing a complexity that would make this not work as well as I’m thinking?
Low Priority:
Better documentation for the Sync function. It is not clear enough in the online materials that if you create two remote vaults and connect them to the same local database, that its just switching the same content between two remote vaults. The filtering features are referenced which is good, but it is not obvious how a user could apply them. Examples of scenarios a user may want to apply multiple sync vaults might be valuable for people to conceptualize the scenarios. Screen shots add to the narrative.
This helps the consumer understand the value of the product and conditions they may want to apply it.
https://help.obsidian.md/How+to/Working+with+tags indicates that tags should be included like this:
tags:
This didn't work for me. The following syntax worked
tags: [tag1, tag2]
The following paragraph-manipulating shortcuts in Obsidian are quite handy but not documented, probably because they aren't editable, overlap with non-app-specific keyboard shortcuts, and are context-specific. It would be nice if they could be fit in the documentation somewhere, as they're very hard to discover otherwise (I found reference to them in a forum post):
These shortcuts function similarly to "Delete paragraph."
==
Another forum poster, malecjan, recommended putting the documentation of this shortcut in a new doc section like:
...
... (add info about dragging)
To copy/cut the current paragraph, place the text cursor in the paragraph and press Ctrl/Cmd-C or Ctrl/Cmd-X while no text is selected.
I'm trying to keep track of translation progress imitating Italian translation issue for my motivation😹
As of 2020-12-02, the current state of the translation process is up-to-date.
Seems like we forgot to document that you can drag headings to arrange in outline plugin
Hi Obsidian Devs, I think it is the closest repo for website bug reports.
Opening obsidian.md on Chrome and Safari, note that the "frosted glass" blur effect is missing in Safari.
This is because the backdrop-filter: blur(5px)
property is not supported in Webkit (MDN), but is available as
Implemented with the vendor prefix: -webkit-
When I edit the CSS on Safari to add -webkit-backdrop-filter: blur(5px)
, it works as intended:
Safari Version: macOS 15.0 Beta 1
Danish documentation is 100% translated and I keep the Danish docs updated as it gets updated in the obsidian-docs repository.
It would be nice if my work also got released from time to time. Ideally as part of all new releases including insider builds but at least as part of public releases.
Another effect will be that the users have the most current documentation available :)
/Henrik :)
Related #269
Porting a template from Jinja to the Obsidian Core Templates plugin, I got tripped up by Obsidian's more restrictive syntax.
In Jinja, template variables are conventional written with spaces, like {{ title }}
, although they also work with {{title}}
.
Obsidian does not recognise the variable unless the spaces are removed {{title}}
.
I feel it would be helpful to document this Obsidian restriction/limitation, to help those migrating from other templating systems.
Sometimes people setup their vault in OneDrive before switching to Sync, and OneDrive (and also the other competitors) have this mode called "Files On-Demand" enabled by default. It causes the files to be deleted on disk and Sync to think they have been deleted.
Perhaps we should have a section in the third party sync page to talk about this scenario.
(And more broadly, maybe we need somewhere in the setup guide workflow to specifically instruct people to move their vault outside of their previous third party sync solution)
https://help.obsidian.md/Licenses+%26+Payment/Commercial+license FAQ 10 is missing an "I" it currently says "f your involves producing [...]"
The page on this repository is not fully updated so I thought it would be best if I created an issue.
When updating from 0.14.15 to 0.15.6, I see a new core plugin called "Unique Note Creator". I assume this is a rename of the "Zettelkasten prefixer", since that has disappeared, but that is not going to be findable at all for new Obsidian users. Could the help site please be updated with the new core plugin name? Thanks!
When installing the snap package on Linux, error on install. Unsigned package.
sudo snap install obsidian_0.11.13_amd64.snap
error: cannot install "obsidian_0.11.13_amd64": invalid instance name: invalid instance key:
"0.11.13_amd64"
WORKAROUND:
sudo snap install --dangerous obsidian_0.11.13_amd64.snap
OS: Ubuntu 20.04 focal
Kernel: x86_64 Linux 5.8.0-50-generic
Shell: bash 5.0.17
Resolution: 8768x2466
DE: GNOME 3.36.5
GTK Theme: Yaru-dark [GTK2/3]
Icon Theme: Yaru
CPU: Intel Core i7-8700K @ 12x 4.7GHz [50.0°C]
GPU: GeForce GTX 1080 Ti
RAM: 6978MiB / 64139MiB
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.