License · CC0 1.0 · Peerpedia collaboration terms
← Peerpedia demo — a template for your first note Paper detailsSnapshot 261020.482cb0378e6f
Peerpedia demo — a template for your first note
Accepted 20 Oct 2026, 08:28 UTC
Publish a reusable CC0 demo with chapters, rendered examples, diagrams, references, and collaboration instructions.
- Submission hash
482cb0378e6f51568432c10dfd52e491c25deb21bde6f210220ac128ad0dcc8d
View Markdown changes
Use the template from your computer
--- Base version+++ Proposed version@@ -0,0 +1,44 @@+## Download the source {#sec:cli}++The CLI is an optional command-line tool for people who prefer their own editor or use an AI coding assistant. You can do all the writing described in the earlier chapters through the website.++With Python 3.12 or newer and pipx installed, install the released client.++```sh+pipx install peerpedia-cli+peerpedia --version+```++To download this demo, replace `PAPER_ID` below with its paper ID. You can find that ID in the paper's details-page address, immediately after `/papers/`. Choose a new destination folder.++```sh+peerpedia clone PAPER_ID ./peerpedia-demo --server https://peerpedia.dev+```++The downloaded folder contains the chapter files, `paper.json`, the shared bibliography, and the CLI's tracking data. You can read it without signing in.++### Start a separate note from the examples++Cloning keeps a connection to this demo. Pushing edits from that copy proposes a PR to this paper. To publish your own independent note, start a new folder instead.++```sh+peerpedia init ./my-note --server https://peerpedia.dev+```++Copy the examples you want into the new note. Set your own metadata in `paper.json`. For a note with two chapters, the chapter-related fields look like this.++```json+{+ "chapters": [+ {"id": "introduction", "title": "Introduction", "file": "chapters/introduction.md"},+ {"id": "examples", "title": "Examples", "file": "chapters/examples.md"}+ ],+ "bibliography": "references.bib"+}+```++These are part of the metadata, not a replacement for the title, author list, abstract, subjects, and license. Keep chapter IDs stable if you rename or reorder chapters. Do not copy the demo's hidden `.peerpedia` tracking folder into your new note.++Read the [CLI guide](https://peerpedia.dev/help/cli/) for account connection and submission. A push from a new note publishes immediately. A push from a clone proposes a revision. Review the local differences before either action, and include `--ai-assisted` if AI helped prepare the submission.++Return to @sec:start to use the browser-only path.
Accepted by ChenqiMeng on 20 Oct 2026, 08:28 UTC. The submitted snapshot is preserved.
Conversation
0 commentsNo comments yet. Discuss the proposed change here.
Sign in to join the conversation.