obsidian-html-server - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #llm #golang #go #android #rust #linux #java #windows #kubernetes #vue #pytorch #ios

obsidian-html-server

(★ 131)

Obsidian plugin to serve a vault as an html site.

File Explorer

Download Latest Version (.zip)

- example-test.ts
- frontmatter_vars.png
- rendered_example.png
- vars.png
- start-obsidian.cjs
- version-bump.mjs
- - main.ts
  - uiSetup.ts
- typings.ts
- - app.json
  - appearance.json
  - community-plugins.json
  - core-plugins-migration.json
  - core-plugins.json
  - daily-notes.json
  - hotkeys.json
  - note-composer.json
- - Index Page.md
- - Simple Renderer Test.md
- Callouts.md
- file1.md
- img.png
- Test File.md
- test.canvas
- globalSetup.js
- globalTeardown.js
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmrc
.prettierignore
.prettierrc.json
jest-puppeteer.config.js
jest.config.js
LICENCE
manifest.json
package-lock.json
package.json
README.md
rollup.config.mjs
styles.css
ts-jest-puppeteer-preset.js
tsconfig.dev.json
tsconfig.json
versions.json

# Installation Guide

1. Get the code

git clone https://github.com/Pr0dt0s/obsidian-html-server

Downloads the entire project code from GitHub to your computer.

cd obsidian-html-server

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Obsidian HTML Server

This plugin allows you to serve your Obsidian vault as an HTTP server, while maintaining your theme and ensuring that your image and file links work.

## Usage

Simply enable the plugin, start the server and open a web browser at `http://localhost:8080/A_MARKDOWN_FILE` to view the same document you see when opening it in Obsidian.

## Notes

- This plugin is intended for sharing your vault within a local network.
- The server is view-only, meaning that no one can change the files in your vault.
- All of the themes and customizations that are visible in Obsidian will be available in the browser.
- Interactivity has not been implemented yet.

## Tips

- To access the server on your local machine, you can use `localhost`. However, for other devices on your network, you will need to use your IP address.
- Create a markdown file with links to other files and use it as an index page (default page), which you can set in your settings.
- If there is an error starting the server, it might be because the port is already in use. In this case, simply change the port to another number.
- You can use [ngrok](https://ngrok.com/) to share your vault openly with someone outside of your local network.

## Issues/Requests

If you encounter any issues or would like to request a new feature, please submit them [here](https://github.com/Pr0dt0s/obsidian-html-server/issues/new).

<details>
<summary>Advanced Usage</summary>

This plugin uses variables in the templates to replace content in the HTML that is served. The default variables can be seen by enabling the setting `Show Advanced Settings.` as shown below.

![/assets/vars.png](https://raw.githubusercontent.com/Pr0dt0s/obsidian-html-server/master/assets/vars.png)

These variables have default values set in the plugins configuration, but can be modified using the frontmatter of each file. The variables are applied using the following priority:

1. Variable values from the file's frontmatter:

```
---
tags: Test File, development
htmlvars:
  LANG: en
  HTML_TITLE: Custom Tab Title!
  RENDERED_CONTENT_FILE_NAME: '<div style="padding:10;
    background-color: #a455a1; width: 100%;"> Custom File Title
    Content from FrontMatter!</div>'
---
```

> These variables must be set inside a property named `htmlvars` in the frontmatter following YAML syntaxis.

2. Variable values set in the settings.

> These would work as default values if the variable is not set in a specific file.

3. Internal values set from the plugin.

The `internal variables` used at the moment are:

- RENDERED_CONTENT_FILE_NAME (The file name that is being opened)
- RENDERED_CONTENT (the whole content of the rendered file)
- THEME_MODE (`theme-dark` or `theme-light` according to your current appearance settings)

Please take note that you **can** overwrite the `internal variables` either from the settings or from the file's frontmatter.

You can use other frontmatter properties as variables in your templates but they can only be Strings or Numbers and you must prefix `FM:` to the variable name.

Example:

```
---
tags: Test File, development
---
```

And in the html template you would use it like this:

```html
#VAR{FM:tags}
```

![/assets/frontmatter_vars.png](https://raw.githubusercontent.com/Pr0dt0s/obsidian-html-server/master/assets/frontmatter_vars.png)
![/assets/rendered_example.png](https://raw.githubusercontent.com/Pr0dt0s/obsidian-html-server/master/assets/rendered_example.png)

</details>

---
<br>

This project is tested with BrowserStack. [Check BrowserStack here.](https://www.browserstack.com/).

<a href="https://www.buymeacoffee.com/pr0dt0s"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=pr0dt0s&button_colour=5F7FFF&font_colour=ffffff&font_family=Poppins&outline_colour=000000&coffee_colour=FFDD00" /></a>