Skip to content

03 Perlite Settings

sec77 edited this page May 24, 2024 · 25 revisions

Required Obsidian Settings

Internal Links

You need to set Files & Links in the options from Shortest path when possible to Relative path to file Link Options

Absolute path to file is also supported but need to be set in the Perlite Settings, check the ABSOLUTE_PATHES setting.

⚠️ This options only applies for new created links, so you need to fix already existing links in your files. Obsidian can automatically update internal links in your vault when you rename or move a file.

Fix already created links

You can use the obsidian-link-converter plugin for this. After installation, change the "Converted Link Format" to "Relative Path" or "Absolute Path" in the Plugin options

image

Then go to the command palette and search for vault: and select convert all "Links to Markdown". Confirm the Messagebox and do the same again but this time select "Links to Wiki", this way you can force the plugin to update all your links to the correct format.

image

If you only want to convert Links in specific files you can use the context menu on you markdown file and choose "All Links to Relative Path | Absolute Path"

image


Wikilinks

for internal links (like to other files or images) only Wikilinks are supported, so make sure that you have turned this option on (default) image


Optional Perlite Settings

There are some Perlite specific settings which you can adjust. Define these either in your docker-compose file or in your php fpm config file

NOTES_PATH

set NOTES_PATH=Demo, to define the obsidian vault folder (root path/folder) of you notes, the folder need be a subfolder of Perlite/perlite

HIDE_FOLDERS

set HIDE_FOLDERS=docs,private,trash, to exclude (array of) folders to be visible in the left side nav panel. Folders and files starting with a "." (dot) are exclude by default.

LINE_BREAKS

set LINE_BREAKS=true, if you want to use "simple" line breaks instead of markdown line breaks

ALLOWED_FILE_LINK_TYPES

set ALLOWED_FILE_LINK_TYPES=pdf,doc, (array of) file types you want to allow to be displayed as a direct link in your notes.

ABSOLUTE_PATHES

set ABSOLUTE_PATHES=true, to use absolute file paths instead of relative paths for internal links.

DISABLE_POP_HOVER

set DISABLE_POP_HOVER=true, to set the default behavior of the pop up on hover over internal links

SHOW_TOC

set SHOW_TOC=true, if you want to show the table of contents (outline) per default instead of the local graph

HOME_FILE

set HOME_FILE=README, if you want to set your home page to README.md in the vault root directory. This must be a .md file, so you need to define the filename only (without the extension)

FONT_SIZE

set FONT_SIZE=15, to set the default font size

HTML_SAFE_MODE

set HTML_SAFE_MODE=false, to allow html in your markdown

TEMP_PATH

set TEMP_PATH=/tmp, to define the location where the graph temp file will be stored

Social Media Settings

set these settings for Social Media Meta Tags

  • SITE_TITLE=Demo
  • SITE_TYPE=article
  • SITE_URL=
  • SITE_IMAGE=
  • SITE_DESC=
  • SITE_NAME=
  • SITE_TWITTER=

Custom Site Settings

image

To enable the custom site view in the top left corner, you need to set a SITE_LOGO. For example SITE_LOGO=logo.svg. When you set a png or jpg, the logo will be rounded (you can change this in the perlite.css). You need to set a relative path to you logo from the perlite folder (where the helper.php is stored)

  • The website description below the logo will be used from SITE_DESC
  • The link to X will be used from SITE_TWITTER.
  • For a Github link you can set SITE_GITHUB
  • For a custom Website link (the flag icon) you can set SITE_HOMEPAGE. If not set, the the SITE_URL will be used.

Perlite Frontend Settings

You can change some settings of the Perlite frontend, these settings will be stored per user in the local browser storage

image

image