Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/FUNDING.yml

This file was deleted.

24 changes: 21 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

# IDEs
.idea/
.vscode/

# Book output
output/
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
# Rust Nostr Book

## Developers
## Installation

### Requirements
```bash
yarn
```

## Local Development

```bash
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.

* [Just](https://github.com/casey/just): install with `cargo install just`
## Build

Serve the site with:
```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
just serve
USE_SSH=true yarn deploy
```

To test all the snippets:
Not using SSH:

```bash
just test
GIT_USER=<Your GitHub username> 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.

9 changes: 9 additions & 0 deletions blog/2025-08-25-docusaurus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Migration to Docusaurus
authors: [yuki]
tags: []
---

Migration from mdbook to Docusaurus.

{/* truncate */}
8 changes: 8 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
yuki:
name: Yuki Kishimoto
title: Lead maintainer
url: https://yukikishimoto.com
image_url: https://yukikishimoto.com/images/avatar.jpg
page: true
socials:
github: yukibtc
Empty file added blog/tags.yml
Empty file.
31 changes: 0 additions & 31 deletions book.toml

This file was deleted.

51 changes: 0 additions & 51 deletions contrib/content-tabs-template.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
---

# Introduction

Loading
Loading