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.

Sign up for GitHub

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

Jump to bottom

Migrate Jazzy documentation to DocC #21

Open
vojtamolda opened this issue Dec 30, 2021 · 0 comments
Open

Migrate Jazzy documentation to DocC #21

vojtamolda opened this issue Dec 30, 2021 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@vojtamolda
Copy link
Owner

Apple released a new DocC (Documentation Compiler) framework. It maybe worthwhile switching from Jazzy.

Here's a few key DocC features:

  • Directly supported in Xcode Help viewer
  • Integrated hints displayed in the code editor
  • Static site export

It looks like DocC requires rolling ones own server for hosting. However, there's some effort to support fully static hosting, i.e. GitHub pages, being discussed here.
@vojtamolda vojtamolda added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vojtamolda