Next.jsReactStarter

Yasow — Next.js Starter Template

By khoeos

Yasow is a Next.js-based starter kit for publishing Obsidian-style notes or Markdown content online, supporting drag-and-drop of an Obsidian vault, folder navigation, automatic links, and light/dark themes.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews
Desktop homepage1 / 2
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-14View source

What stands out

A quick read of the recorded project description.

01

Next.js-based starter kit for publishing Obsidian-style notes or Markdown content

02

Supports drag-and-drop of an Obsidian vault, with full support for special characters and unlimited directory depth

03

Automatic links [[]] with alias support, folder navigation, and automatic table of contents

04

Light/dark themes, with custom Markdown rendering via React components

05

Full Markdown support, including code blocks with syntax highlighting

06

Configurable page visibility; tag pages and Canvas are partially supported

Template Details

Yasow is a starter kit built with Next.js, aimed at making it easy to put notes or Markdown content based on Obsidian's structure and way of working online. The README states that it is still in an early stage, with some features missing and some possibly problematic, but it is already usable.

It targets two types of users. Regular users can drag and drop their own Obsidian vault, put it on GitHub, and host it on Vercel, so they can access their notes from anywhere. Developers or people with a little coding knowledge can customize the app as needed, or even add features themselves; the author says they want to keep Yasow simple enough.

In terms of features, the README lists: drag-and-drop of an Obsidian vault (full support for special characters, unlimited directory depth), automatic links [[]] with alias support, folder navigation, automatic table of contents, light/dark themes, custom Markdown rendering with React components, full Markdown support (including code blocks with syntax highlighting), and configurable page visibility. Tag pages and Canvas support are marked as partially supported. Planned features include: using Home.md or Index.md in a directory as that directory's homepage (showing a subdirectory listing when the file does not exist), search, Emoji in file or folder names as icons, graph view, and password-protected pages.

The README does not specify exact dependency versions, deployment configuration details, or performance. The project uses the MIT license and states that it is not affiliated with, endorsed by, or associated with Obsidian.

Next.jsStarter kit

Is it right for your project?

Use Cases

  • Publishing a personal Obsidian vault as a website accessible online
  • Organizing and displaying Markdown content according to Obsidian's folder structure
  • Hosting content on GitHub and deploying to Vercel to access notes anywhere
  • Developers customizing Markdown rendering or extending features to suit their own needs

Suitable For

  • Users who want to put their Obsidian vault online without using the official publishing feature
  • Regular users willing to host note content with GitHub and Vercel
  • Developers who want to customize a note site based on an existing starter kit
  • Markdown content sites that need folder navigation, automatic table of contents, and light/dark themes

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    The installation command given in the README is npm run install

  2. 2

    Run npm run dev for development mode, then open http://localhost:3000 in the browser

  3. 3

    The README recommends using VSCode with the ESLint and Prettier extensions

  4. 4

    The README does not provide detailed instructions for production deployment, environment variables, or configuration options

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of that version and does not mean external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of that version's code are permitted.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses; they cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur separate charges.
  • Regular users need to put their Obsidian vault on GitHub and host it on Vercel to access notes online; this depends on the external services GitHub and Vercel.
  • The project is in an early stage, with some features missing and some possibly problematic; although it is usable, it is not guaranteed to be complete or stable.
  • The project is not affiliated with, endorsed by, or associated with Obsidian; Obsidian-related trademarks and copyrights belong to their respective owners.
View Original Text Basis

Permission is hereby granted, free of charge

Original License Text

As a simple user, you can drag'n'drop your obsidian vault, put it on github and host it on Vercel, and you're done. You can now access your notes from anywhere. Yasow has some basic features and some more coming soon.

Original README

Yasow is in it's early stage, and some features are missing, some may bug, but it's already usable. Feel free to contribute to the project, or ask for features.

Original README

This project, Yasow, is an open-source tool developed by the community and is not affiliated with, endorsed by, or associated with Obsidian in any way. All trademarks and copyrights related to Obsidian are the property of their respective owners. This tool is provided as-is with no guarantees or warranties.

Original README
https://github.com/khoeos/Yasow/blob/main/LICENSEhttps://github.com/khoeos/Yasow/blob/main/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-14. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 83 / 100
Technologies
Next.js · React
Website type
Starter
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2025-12-30
Screenshot last checked
2026-10-14

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Next.js as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: codex-user-requested-batch-review-20261015 · 2026-10-15

Inspect the recorded source material

SHA-256: cb186bd0344a2c235beeb29c336d904bfa847ee73a9ca8980bcfd7ed3d407293

2026-10-14T05:50:15.183Z

Source file / repository
[![stars-shield](https://img.shields.io/github/stars/Khoeos/Yasow.svg?style=for-the-badge)](https://github.com/Khoeos/Yasow/stargazers)
[![contributors-shield](https://img.shields.io/github/contributors/Khoeos/Yasow.svg?style=for-the-badge)](https://github.com/Khoeos/Yasow/graphs/contributors)
[![issues-shield](https://img.shields.io/github/issues/Khoeos/Yasow.svg?style=for-the-badge)](https://github.com/Khoeos/Yasow/issues)
![License MIT](https://img.shields.io/github/license/khoeos/Yasow?style=for-the-badge)

<h1 align="center">Yasow</h1>

<a href="https://github.com/khoeos/Yasow">
    <img src="https://github.com/khoeos/Yasow/blob/main/screenshots/1.png?raw=true" alt="Logo">
  </a>
  <p align="center">
    A bare-bone starter kit for your obsidian vault on modern web technologies.
    <br />
    <br/>
    <a href="https://yasow.vercel.app/">Explore the docs »</a>
    <br />
    <br />
    <a href="https://github.com/khoeos/Yasow/issues">Report Bug</a>
    ·
    <a href="https://github.com/khoeos/Yasow/issues">Request Feature</a>
    ·
    <a href="https://discord.gg/F58Jm36r5J">Join discord server</a>
  </p>
</p>

# Yasow

Yasow is a starter kit made with Next.js to easily put online notes or markdown content based on the operation and structure of [Obsidian](https://obsidian.md/).

Yasow is in it's early stage, and some features are missing, some may bug, but it's already usable. Feel free to contribute to the project, or ask for features.

## Why Yasow

I've created Yasow because i wanted to put my notes online, and i wanted to keep the same structure and features as Obsidian. As a developped already having servers, i didn't want to use the official feature, and i wanted to have more control on the app over some other alternatives.

As a simple user, you can drag'n'drop your obsidian vault, put it on github and host it on Vercel, and you're done. You can now access your notes from anywhere. Yasow has some basic features and some more coming soon.

But if you are a developper, or know a little bit of code, that's where things start to be interesting, you can easily customize the app to fit your needs, and even add some features that you want. I want to keep Yasow quite simple.

*Why "Yasow" ? **Y**et **A**nother **S**imple **O**bsidian **W**ebsite.* (Yes i'm very imaginative 🙃)

## Features

- Drag'N'Drop obsidian vault
  - Special characters 100% supported
  - As deep as you want
- Automatic links `[[]]` with aliases support
- Folder navigation
- Automatic table of content
- Light and dark theme
- Customize markdown rendering with react components
- Full markdown support (even codeblocs with syntax highlighting)
- Configurable page visibility

### Partially supported
- Page for tags
- Canvas support

### Planned

- Home.md of Index.md as homepage of the directory
  - If the file dont' exist, a table of content of the childs of the directory
- Search
- Emoji as file/folder icon if it's on the name
- Graph View
- Password protected page

## Contributing

Contributions are what make the open source community. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

Don't hesitate to pm me on discord to talk about the app. You can find my tag lower.


## License

This project is licensed under the [MIT License](https://opensource.org/license/mit). You are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the conditions stated in the license. In all cases, you must include the full MIT License text in any significant portions or distributions of this project.

## Contact

[![logo-discord](https://img.shields.io/badge/khoeos-grey?style=for-the-badge&logo=discord)](https://discordapp.com/users/170144954964770816)
[![logo-reddit](https://img.shields.io/badge/khoeos-grey?style=for-the-badge&logo=reddit)](https://www.reddit.com/user/khoeos/)
[![logo-reddit](https://img.shields.io/badge/Thread-grey?style=for-the-badge&logo=reddit)](https://www.reddit.com/user/khoeos/)

- Project Link: [https://github.com/khoeos/Yasow](https://github.com/khoeos/Yasow)
- Discord server: [https://discord.gg/F58Jm36r5J](https://discord.gg/F58Jm36r5J)

## Project Setup

### Recommended IDE Setup

- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

### Install

```bash
$ npm run install
```

### Development

```bash
$ npm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Disclaimer

This project, Yasow, is an open-source tool developed by the community and is not affiliated with, endorsed by, or associated with Obsidian in any way. All trademarks and copyrights related to Obsidian are the property of their respective owners. This tool is provided as-is with no guarantees or warranties.
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.