Repository navigation
Docs - #17
Closed
RobotOptimist wants to merge 24 commits into
Closed
Docs#17RobotOptimist wants to merge 24 commits into
RobotOptimist wants to merge 24 commits into
Conversation
get latest from davidfowl
davidfowl
reviewed
Jan 23, 2020
Contributor
Author
|
I've got other enhancements I want to make to this anyway, I'm closing this |
Closed
This file contains hidden or 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
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.
Okay, I finally got this done.
#7
Deployment
This puts the static site generator into the docs folder in the regular project.
Regarding the deployment: on push to master, the new ci job will generate the static site and then deploy it to a gh-pages branch
Stuff you'll need to do:
Stuff you may want to do
Be aware also that github pages use case sensitive routes so it's going to be https://davidfowl.github.io/FeatherHttp
just fyi that https://davidfowl.github.io/featherhttp will not work.
Once you've done your first successful deployment from the ci build to gh-pages you can configure github to create your docs site
Local dev
This will go into the contribution guide as well, but you can build and run this from the docs folder after you pull it down to your local environment
you can deploy changes directly to the gh-pages from your local by doing this:
Content
I've got a rudimentary getting started section and I'm working on a docs contribution guide + cleaning up the syntax a bit.
This is using tailwind.css similar to the go site you wanted to model off of, but we can switch to bootstrap.css if you want to make this easier for people to add custom styles since lots of people know bootstrap.
Otherwise, I can make the example pages markdown friendly by including another plugin and then contributors can add to the docs files in markdown.
If we want to get really fancy then I can try to devise a way to pull in the .md files from each sample and dynamically create these vue files from that. Not sure how brittle that would be - but I might able do it if you want that.