Yasow — Next.js 启动器模板

SHA-256: cb186bd0344a2c235beeb29c336d904bfa847ee73a9ca8980bcfd7ed3d407293

2026-10-14T05:50:15.183Z

[![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.