@@ -6,6 +6,21 @@ This is the repo containing the kroxylicious.io website.
66The site runs on Jekyll, so you'll need to ensure you have the [ prerequisites] ( https://jekyllrb.com/docs/ ) installed to try it locally.
77You'll also need to ensure you have Ruby 3.2+ installed, along with the latest versions of Rake and Bundler for your Ruby distribution.
88
9+ <!-- TOC -->
10+ * [ Kroxylicous.io Site] ( #kroxylicousio-site )
11+ * [ What?] ( #what )
12+ * [ Key Files] ( #key-files )
13+ * [ Development] ( #development )
14+ * [ Running in a Container] ( #running-in-a-container )
15+ * [ Building Production HTML] ( #building-production-html )
16+ * [ Running on GitHub Pages on a Fork] ( #running-on-github-pages-on-a-fork )
17+ * [ Binary content] ( #binary-content )
18+ * [ Excalidraw images] ( #excalidraw-images )
19+ * [ Redirects] ( #redirects )
20+ * [ Issues] ( #issues )
21+ * [ Contributing] ( #contributing )
22+ <!-- TOC -->
23+
924## Key Files
1025- [ Gemfile] ( Gemfile ) - required ruby gems for building and serving the site
1126- [ _ config.yml] ( _config.yml ) - Jekyll configuration for building the site
@@ -86,4 +101,12 @@ mappings:
86101 fromVersion: 0.10.0 #Optional, if not specified the latest release at time of site build is used.
87102 toVersion: 0.12.0 #Optional, if not specified the latest release at time of site build is used.
88103 path: /html/kroxylicious-proxy/#con-configuring-client-connections-proxy # the path within the baseUrl
89- ` ` `
104+ ` ` `
105+
106+ # Issues
107+
108+ Issues are tracked in the `kroxylicious/kroxylicious` [Issue tracker](https://github.com/kroxylicious/kroxylicious/issues)
109+
110+ # Contributing
111+
112+ We welcome contributions! Please see our [contributing guidelines](https://github.com/kroxylicious/.github/blob/main/CONTRIBUTING.md) to get started.
0 commit comments