Sources for the www.slatekit.com Website
Slate Kit is a Kotlin Tool-Kit, a simple, light-weight, modular framework to build Apps, APIs, CLIs, Jobs, and more for Start-ups, Personal projects, and SMBs ( small-medium sized businesses ). These libraries can be used for both Server and Android and there are modules for the server that abstract infrastructure ( Queues, Files, SMS, Emails, Alerts ) with integrations for AWS ( SQS, S3 ), Twilio ( SMS ), SendGrid ( Email ), Slack ( Alerts ) and more. Multi-platform support is planned as a future state.
This contains all the source code for generating www.slatekit.com site content. This uses a static site generator ( Hugo ) and most of the content is in markdown. It is automatically published via github-pages.
| num | type | link |
|---|---|---|
| 1 | Website | https://www.slatekit.com |
| 2 | Framework | https://github.com/slatekit/slatekit |
| 3 | Modules | https://www.slatekit.com/arch/overview/ |
| 4 | Install | https://github.com/slatekit/slatekit-cli ( Homebrew ) |
- Hugo ( see https://gohugo.io/getting-started/installing/ )
- Clone this repo ( git clone git@github.com:code-helix/slatekit-site.git )
Currently, the root directory of the hugo theme/site is at src/hugo/slatekit-v3
# Move to dir
cd ~/git/slatekit/slatekit-site/src/hugo/slatekit-v3
# Run hugo while serving drafts
hugo serve -D
# Go to http://localhost:1313/Make changes on a separate branch e.g docs-version-1.20.0 and then merge to main/master.
- Move to directory
cd ~/git/slatekit-site/src/hugo/slatekit-v3 - Generate site
hugo - Content is at
~/git/slatekit-site/src/hugo/slatekit-v3/public - Copy content to root directory e.g.
public/info->~/git/slatekit-site/info - Publish your branch
- Create a PR to merge your branch to main/master.
- After the merge to main/master, the site will automatically update(delayed due to cached content)
| name | purpose | location |
|---|---|---|
| theme | theme for site | src/hugo/slatekit-v3/themes/wavo |
| content | content for page | src/hugo/slatekit-v3/content/start/overview |
| assets | js,css,img | src/hugo/slatekit-v3/themes/wavo/static/assets |
| shortcodes | reusable html | src/hugo/slatekit-v3/themes/layouts/shortcodes/sk-modules.html |