Create basic setup for Jekyll-based documentation website #1208
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
This Jekyll setup is intentionally simple and theme-less. Templating and front matter is kept out of the actual Markdown content files as much as possible such that those files can also be read directly on GitHub. The SCSS utilities under `_sass/utility/` mostly make use of class names employed by Tailwind CSS.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is another attempt at getting a documentation website for Moq v4 up and running.
Preview the resulting website at stakx.github.io/moq4.
Instead of basing it on DocFX (as before in #799), this time I'm using Jekyll, which is tightly integrated with GitHub Pages. I explained my thinking behind this choice briefly in #1090 (comment), but mostly I believe that Moq is primarily lacking conceptual documentation, not online API reference pages (at least not as long as those are simply a duplicate of what IntelliSense would give you).
This Jekyll setup is kept intentionally simple and theme-less. (Or rather, it includes a very basic theme that approximates the appearance of https://www.moqthis.com.) Templating and front matter is kept out of the actual Markdown content files. The idea behind this is that those Markdown files can also be read directly on GitHub.
The SCSS utilities under
_sass/utility/mostly make use of class names employed by Tailwind CSS.