Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick How-Tos for PreTeXt quickstart #2212

Open
hammadmazhar1 opened this issue Jul 18, 2024 · 0 comments
Open

Quick How-Tos for PreTeXt quickstart #2212

hammadmazhar1 opened this issue Jul 18, 2024 · 0 comments

Comments

@hammadmazhar1
Copy link

There should be small 5-10 min quickstart guides to have new users get started with PreTeXt, on their machine locally and on their document of choice. Ideally such guides include code examples that users can copy/paste into their terminals/documents, a
nd structured as:

  1. Installing PreText-CLI (list dependencies)
  2. Create PreTeXt project with CLI for requisite document
    a. Include document specific schema tags with illustrative code examples
  3. Describe document structure e.g. front matter, back matter, body with pointers to where they lie in project directory
  4. Describe how to build/view/deploy project, showing WHERE the output lies (so someone can take the output and hand it over to their IT department for instance)
  5. Describe 'embeddables' and have code examples for inserting them.
  6. Sharing PreTeXt project source with other collaborators (not HTML)

As an additional 'ask', we could have some form of script that can do the legwork of this that a user just downloads and runs and gets what they need. A rudimentary example is here that installs Python, PreTeXt CLI, VS Code (if not present) and a given template from a repo and displays it to the user in the text editor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant