The current Knowledge base is a mix of reality, dreams, visions, actuality and plans.

When accessing the documentation on GitHub, please be aware that the content may not be fully represented. To ensure a comprehensive understanding of the Pubky Knowledge Base, we recommend importing the data into Obsidian or Quartz site. This will enable you to access the complete range of information and features available in the repository.

The following blocks provide step-by-step guidance on how to import the Pubky Knowledge Base.

Obsidian

The root directory is an Obsidian Vault.

1. Download Obsidian app
2. Add a new vault selecting the folder path

Build static Quartz site

For those who prefer to render the documentation directly in their browser, a preliminary step is required. To facilitate this, please ensure that NodeJS 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