Improve Obsidian Publish docs

obsidianmd · Nov 26, 2021 · 5ffe462 · 5ffe462
1 parent 2880009
commit 5ffe462
Show file tree

Hide file tree

Showing 16 changed files with 338 additions and 331 deletions.
diff --git a/en/Advanced topics/Contributing to Obsidian.md b/en/Advanced topics/Contributing to Obsidian.md
@@ -10,7 +10,7 @@ If you'd like to use Obsidian for work activities, try to let your work get you
 
 #### Add-on services
 
-If you'd like to make a website from your notes, consider getting [[Obsidian Publish]] if the price works for you.
+If you'd like to make a website from your notes, consider getting [[Introduction to Obsidian Publish|Obsidian Publish]] if the price works for you.
 
 If you're interested in an end-to-end encryption syncing solution, we also offer [[Introduction to Obsidian Sync|Obsidian Sync]]. In addition to end-to-end encryption, Obsidian Sync also comes with version history.
 

diff --git a/en/Advanced topics/YAML front matter.md b/en/Advanced topics/YAML front matter.md
@@ -26,6 +26,6 @@ As of 0.12.12, there are four keys natively supported:
 - `tags` ([[Working with tags|more information]])
 - `aliases` ([[Add aliases to note|more information]])
 - `cssclass`
-- `publish`([[Publish#YAML support for Publish|more information]])
+- `publish`([[Publish and unpublish notes#Automatically select notes to publish]] and [[Publish and unpublish notes#Ignore notes]])
 
 As Obsidian continues to develop, we will gradually make it more accessible by plugin developers, and make it more user friendly.
diff --git a/en/How to/Add custom styles.md b/en/How to/Add custom styles.md
@@ -24,16 +24,3 @@ You can find this configuration in `Settings` => `Appearance`. You can choose a
 CSS snippets are supposed to be small pieces of CSS for small changes you want to make/things you want to add. These snippets have to be placed in the shown directory.
 
 You can go to the respective directories by clicking on the folder buttons. If the folder isn't created yet, it will be. In case your snippets or theme don't show up after you've put them there, you can click the button next to the folder icon to refresh the list.
-
-## Obsidian Publish styles
-
-At this time, [[Obsidian Publish]] is unable to automatically detect the vault's configured [[Add custom styles#Themes|theme]] and publish the respective styles. 
-
-A workaround for this limitation is to:
-
-1. Go into `YOUR_VAULT/.obsidian/themes/CURRENT_THEME_FOLDER`;
-2. Copy the primary CSS file `CURRENT_THEME.css` in the folder;
-3. Paste it in the root directory of your vault (`YOUR_VAULT`);
-4. Rename the CSS file as `publish.css`;
-5. In the publish plugin, upload the `publish.css` file;
-6. If your CSS doesn't take effect in a few minutes, try refreshing the browser cache as the stale CSS might have been cached.
diff --git a/en/Licenses & add-on services/Obsidian Publish.md b/en/Licenses & add-on services/Obsidian Publish.md
diff --git a/en/Licenses & add-on services/Refund policy.md b/en/Licenses & add-on services/Refund policy.md
@@ -10,8 +10,6 @@ If there is any issue with a transaction, please reach out to support@obsidian.m
 
 ## All other services
 
-For all other services and licenses, including [[Commercial license]], [[Obsidian Publish]], and [[Introduction to Obsidian Sync|Obsidian Sync]], you can request a full refund within 3 days of purchase with no questions asked.
+For all other services and licenses, including [[Commercial license]], [[Introduction to Obsidian Publish|Obsidian Publish]], and [[Introduction to Obsidian Sync|Obsidian Sync]], you can request a full refund within 3 days of purchase with no questions asked.
 
 To request a refund, log into your account [on our Account page](https://obsidian.md/account), and use the **Invoices & Refunds** option. If a payment is refundable, a link to request refund will appear.
-
-Beyond 3 days, if you need a refund due to exceptional circumstances, feel free to reach out to us by emailing support@obsidian.md.
diff --git a/en/Obsidian Publish/Customize your site.md b/en/Obsidian Publish/Customize your site.md
@@ -0,0 +1,53 @@
+This page explains how you can customize how your [[Introduction to Obsidian Publish|Obsidian Publish]] site looks and feels.
+
+## Static assets
+
+You can customize your site by [[Publish and unpublish notes#Publish notes|publishing]] the following files to your site:
+
+- `publish.css` to add custom CSS
+- `publish.js` to add custom JavaScript
+- `favicon-32x32.png` to set the favicon
+
+**Notes:**
+
+- Since Obsidian doesn't support CSS or JavaScript files, you need to use another application to create and edit them.
+- By default, `publish.css` and `publish.js` don't appear in the file explorer, but you can still publish them from the **Publish changes** dialog.
+
+For favicons, Obsidian Publish supports the following naming conventions, where `32` is the icon dimensions in pixels:
+
+- `favicon-32.png`
+- `favicon-32x32.png`
+- `favicon.ico`
+
+We recommend that you provide one or more of the following dimensions:
+
+- `favicon-32x32.png`
+- `favicon-128x128.png`
+- `favicon-152x152.png`
+- `favicon-167x167.png`
+- `favicon-180x180.png`
+- `favicon-192x192.png`
+- `favicon-196x196.png`
+
+## Use a community theme
+
+To use one of the community themes for your site:
+
+1. Open your vault in the default file explorer for your OS.
+2. Go to the vault settings folder (default: `.obsidian`).
+3. Open the `themes` folder.
+4. Copy the CSS file for the theme you want to use for your site.
+5. Paste the file into the root folder of your vault.
+6. Rename the CSS file to `publish.css`.
+7. [[Publish and unpublish notes#Publish notes|Publish]] `publish.css`.
+
+**Notes:**
+
+- If the style doesn't change within a few minutes, you may need to refresh your browser cache.
+- You can switch between light and dark mode in the [[Manage sites#View site options|site options]].
+
+## Enable UI features
+
+You can toggle several UI features for your site, such as the graph view or a table of contents.
+
+Browse the available UI features under the **Reading experience** and **Components** sections in the [[Manage sites#View site options|site options]]
diff --git a/en/Obsidian Publish/Introduction to Obsidian Publish.md b/en/Obsidian Publish/Introduction to Obsidian Publish.md
@@ -0,0 +1,17 @@
+---
+alias: [Obsidian Publish]
+---
+
+Obsidian Publish is a cloud-based service where you can publish your notes to the world.
+
+Select the notes you want to share with the world, press "Publish", and we'll post it to publish.obsidian.md/your-site.
+
+If you're reading this on [help.obsidian.md](https://help.obsidian.md), you're already looking at a site that uses Obsidian Publish. You can see the vault on [GitHub](https://github.com/obsidianmd/obsidian-docs).
+
+## Learn more
+
+- If you a new Obsidian Publish user, learn how to [[Set up Obsidian Publish]].
+- If you have more than one site, learn how to [[Manage sites]].
+- If you want to customize how your site looks, refer to [[Customize your site]].
+- If you want to know how we keep your notes safe, refer to [[Security and privacy]].
+- If you want to use your own domain, refer to [[Set up a custom domain|custom domain]].