Add Laika and API docs #134
Merged
Conversation
This file contains 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
On branch docs-in-ci Your branch is up to date with 'upstream/main'. Changes to be committed: new file: .github/workflows/docs.yml modified: README.md modified: build.sbt new file: docs/about/README.md modified: project/plugins.sbt
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview
How it looks like in my fork
Comments
I think we should refactor
build.sbttolazy valandprojectto separate core and docs. Also it could be cool to move part of leika conf to a separate scala file. But I would do it in a separate PR better.PS
It is the first time when I'm trying to make a website for a scala project. I tried
docusaurus+mdocbut failed. From the other side Laika looks fresh, lightweight and easy to configure compared todocusaurusthat requires solid js/ts knowledge.Content
I will work with extending the documentation, updating README, etc. But I would merge the core part of docs first.
Part of #127