https://github.com/vran-dev/obsidian-components-site
web site for obsidian components plugin
https://github.com/vran-dev/obsidian-components-site
Last synced: 13 days ago
JSON representation
web site for obsidian components plugin
- Host: GitHub
- URL: https://github.com/vran-dev/obsidian-components-site
- Owner: vran-dev
- License: apache-2.0
- Created: 2024-08-07T13:25:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-20T14:27:07.000Z (28 days ago)
- Last Synced: 2026-03-20T22:12:26.815Z (28 days ago)
- Language: TypeScript
- Homepage: https://obsidian-components-site.vercel.app
- Size: 49.5 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obsidian-components-site
web site for obsidian components plugin
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.