mirror of
https://github.com/aljazceru/pubky-knowledge-base.git
synced 2025-12-18 14:24:22 +01:00
22 lines
1.2 KiB
Markdown
22 lines
1.2 KiB
Markdown
# :brain: Pubky Knowledge Base
|
|
|
|
Welcome to the Pubky Knowledge base - we are excited to have you here.
|
|
|
|
### 🔗 [Access the Pubky Knowledge Base: notes.pubky,app!](https://notes.pubky.app)
|
|
|
|
> **The current Knowledge base is a mix of reality, dreams, visions, actuality and plans.**
|
|
|
|
The Knowledge Base is a resource that encompasses our broad vision for Pubky, along with high-level explanations of the architecture for both the Pubky Protocol and the Pubky App, as well as key concepts. Use this as your go-to guide to help you navigate unfamiliar topics and find answers to the most common questions.
|
|
|
|
## 📝 Contributing Knowledge
|
|
|
|
We kindly ask you to help us improve this documentation for a clearer, more accurate and concise knowledge base. Simply open a PR!
|
|
|
|
## 🏗️ Build static Quartz site
|
|
|
|
In order to build the static website from this obsidian vault, ensure that [NodeJS](https://nodejs.org/en/download/prebuilt-installer) is installed on your system.
|
|
|
|
1. Enter in the terminal to the project root and access to the `/quartz` directory (`cd quartz`)
|
|
2. Install dependencies with `npm install`
|
|
3. Finally build the site with `npm run docs` and check it out at [localhost:8080](http://localhost:8080/)
|