-
Notifications
You must be signed in to change notification settings - Fork 368
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f485535
commit cfdfa81
Showing
4 changed files
with
24 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem 'github-pages', group: :jekyll_plugins | ||
gem "just-the-docs" | ||
gem "just-the-docs", "0.7.0" # pinned to latest release for security purposes | ||
|
||
gem "webrick", "~> 1.7" |
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Akamai Cloud Manager Documentation | ||
|
||
This doc builder uses default GitHub pages and its Jekyll site builder to deploy documentation pages to [https://linode.github.io/manager](https://linode.github.io/manager). | ||
|
||
It automatically get deployed when we release to `master`. | ||
It can be customized easily (styles, templates) via updating its configuration and templates (see [documentation](https://just-the-docs.com/docs/configuration)) | ||
|
||
## Local Development | ||
|
||
In order to develop locally, start by setting up your tolling locally by following the steps on this [page](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). | ||
|
||
This should be done from the /docs/ directory. | ||
|
||
Once your local site is running, you can: | ||
|
||
- modify the styles by updating `_sass/color_schemes/akamai.scss`. | ||
- modify layouts by adding/updating HTML templates to the `_includes` directory. | ||
|
||
See [https://just-the-docs.com/docs/customization](https://just-the-docs.com/docs/customization) for mor info. |
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