self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00
Code Issues Releases Activity

Doc: Fixed template doc

Browse Source
This commit is contained in:
Laurent Cozic 2019-07-21 09:07:33 +01:00
parent fd509bb4af
commit f5515e3496
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -316,9 +316,9 @@ It is generally recommended to enter the notes as Markdown as it makes the notes
Rendered markdown can be customized by placing a userstyle file in the profile directory `~/.config/joplin-desktop/userstyle.css` (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin ***must*** be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used only when display the notes, **not when printing or exporting to PDF**. This is because printing has a lot more restrictions (for example, printing white text over a black background is usually not wanted), so special rules are applied to make it look good when printing, and a userstyle.css would interfer with that. Rendered markdown can be customized by placing a userstyle file in the profile directory `~/.config/joplin-desktop/userstyle.css` (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin ***must*** be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used only when display the notes, **not when printing or exporting to PDF**. This is because printing has a lot more restrictions (for example, printing white text over a black background is usually not wanted), so special rules are applied to make it look good when printing, and a userstyle.css would interfer with that.
## New Note Templates ## Note templates
Templates can be used for new notes by creating a templates folder in `~/.config/joplin-desktop/` and placing markdown template files into it. For example creating the file `hours.md` in the directory `~/.config/joplin-desktop/templates/` with the contents: In the **desktop app**, templates can be used to create new notes or to insert into existing ones by creating a `templates` folder in Joplin's config folder and placing Markdown template files into it. For example creating the file `hours.md` in the `templates` directory with the contents:
```markdown ```markdown
Date: {{date}} Date: {{date}}
@ -326,7 +326,7 @@ Hours:
Details: Details:
``` ```
When creating a new note you will now be prompted to insert a template that contains the above text (and `{{date}}` replaced with today's date). Templates can also be inserted from the menu (File->Templates). Templates can then be inserted from the menu (File->Templates).
The currently supported template variables are: The currently supported template variables are:

6
docs/index.html
View File

@ -591,13 +591,13 @@ $$
</code></pre> </code></pre>
<h2><a name="custom-css" href="#custom-css" class="heading-anchor">🔗</a>Custom CSS</h2> <h2><a name="custom-css" href="#custom-css" class="heading-anchor">🔗</a>Custom CSS</h2>
<p>Rendered markdown can be customized by placing a userstyle file in the profile directory <code>~/.config/joplin-desktop/userstyle.css</code> (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin <em><strong>must</strong></em> be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used only when display the notes, <strong>not when printing or exporting to PDF</strong>. This is because printing has a lot more restrictions (for example, printing white text over a black background is usually not wanted), so special rules are applied to make it look good when printing, and a userstyle.css would interfer with that.</p> <p>Rendered markdown can be customized by placing a userstyle file in the profile directory <code>~/.config/joplin-desktop/userstyle.css</code> (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin <em><strong>must</strong></em> be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used only when display the notes, <strong>not when printing or exporting to PDF</strong>. This is because printing has a lot more restrictions (for example, printing white text over a black background is usually not wanted), so special rules are applied to make it look good when printing, and a userstyle.css would interfer with that.</p>
<h2><a name="new-note-templates" href="#new-note-templates" class="heading-anchor">🔗</a>New Note Templates</h2> <h2><a name="note-templates" href="#note-templates" class="heading-anchor">🔗</a>Note templates</h2>
<p>Templates can be used for new notes by creating a templates folder in <code>~/.config/joplin-desktop/</code> and placing markdown template files into it. For example creating the file <code>hours.md</code> in the directory <code>~/.config/joplin-desktop/templates/</code> with the contents:</p> <p>In the <strong>desktop app</strong>, templates can be used to create new notes or to insert into existing ones by creating a <code>templates</code> folder in Joplin's config folder and placing Markdown template files into it. For example creating the file <code>hours.md</code> in the <code>templates</code> directory with the contents:</p>
<pre><code class="language-markdown">Date: {{date}} <pre><code class="language-markdown">Date: {{date}}
Hours: Hours:
Details: Details:
</code></pre> </code></pre>
<p>When creating a new note you will now be prompted to insert a template that contains the above text (and <code>{{date}}</code> replaced with today's date). Templates can also be inserted from the menu (File-&gt;Templates).</p> <p>Templates can then be inserted from the menu (File-&gt;Templates).</p>
<p>The currently supported template variables are:</p> <p>The currently supported template variables are:</p>
<table> <table>
<thead> <thead>