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

Getting started with the VS Code extension #335

Open
mikebarkmin opened this issue Oct 8, 2022 · 1 comment
Open

Getting started with the VS Code extension #335

mikebarkmin opened this issue Oct 8, 2022 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers vscode Issue is related to the VS Code extension

Comments

@mikebarkmin
Copy link
Member

It would be nice if we would have a welcome screen for the VS Code extension. Otherwise, a user does probably not know what to do with it. So we need to define a series of steps for implementing something similar to:

https://github.com/microsoft/vscode-extension-samples/tree/main/getting-started-sample

Possible steps could be:

  • Create new Hyperbook aka. run command hyperbook.new
  • Edit index.md in the folder book
  • Create new page in the book folder
  • Insert a snippet
  • Change the frontmatter of the new page
  • Done

Maybe we also should add steps about syncing the Hyperbook to a git remote and triggering the pipeline.

@mikebarkmin
Copy link
Member Author

For other common operations like adding a logo, changing the brand color etc. we should create videos and add a guide to the documentation.

@mikebarkmin mikebarkmin added enhancement New feature or request good first issue Good for newcomers vscode Issue is related to the VS Code extension labels Oct 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers vscode Issue is related to the VS Code extension
Projects
None yet
Development

No branches or pull requests

1 participant