README
¶
katamari
A projects page generator for GitHub users and organizations
Functionality
- Aggregate all your project READMEs into a single static site
- Support for aggregating User READMEs also
- Generate the static site using Hugo
- Default theme set to "Ananke" (needs git)
- Store GitHub Access Token in config
- Available on the AUR
- Set Hugo configuration without having to edit
config.toml
Getting started
Follow the instructions to get started and run this project.
Arch Linux
This package is available as an AUR.
Dependencies
Installation
go get -u github.com/GDGVIT/katamari
Alternatively, you can also check out releases to get a pre-compiled binary
Generating a katamari project
katamari create <github organization name>
or
katamari create -u <your github username>
Building the katamari project
cd <github organization name>
katamari build
Fix rate limiting
Wherever you install katamari, it creates a config.json file in .katamari folder in the same directory as the executable. You need to add your GitHub Personal Access Token in .katamari/config.json in case you're being rate limited. If you require help in creating a Personal Access Token visit this link.
Contributors
|
Amogh Lele
|
Siddhartha Varma
|
Made with :heart: by DSC VIT
Documentation
¶
Overview ¶
Copyright © 2020 DSCVIT
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Source Files
Directories