Repository navigation
docs: add a tutorial - #219
Merged
Merged
Conversation
docs/tutorial.md is a quick start for a new user: install with Homebrew, set up credentials with credentials-init, look at the personal space with user-info and space-info, write a Markdown file, check it, create the page, list the space with children, and export the page back to a file. The example file has an invalid page_width on purpose, so the reader sees check report a problem, fixes it, and runs check again. The README's documentation table links to it, and CLAUDE.md lists it with the other written documents.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/tutorial.md, a quick start that walks a new user from install to a published and exported page in their personal space:credentials-init, then confirm them and find the personal space key withuser-info.space-info.hello.md, which has an invalidpage_widthon purpose so thatcheckreports it; fix it and runcheckagain.create --dry-run, thencreate, and the frontmatter thatcreatewrites back.children --space.exportthe page, and a pointer todiff.The sample output is what markfluence prints, with the account, site, and ids replaced by example values. The README's documentation table links to the tutorial, and
CLAUDE.mdlists it with the other written documents.