No description
74bc836df9
Bumps [semver](https://github.com/npm/node-semver) from 7.3.8 to 7.5.4. - [Release notes](https://github.com/npm/node-semver/releases) - [Changelog](https://github.com/npm/node-semver/blob/main/CHANGELOG.md) - [Commits](https://github.com/npm/node-semver/compare/v7.3.8...v7.5.4) --- updated-dependencies: - dependency-name: semver dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .github | ||
| api | ||
| assets | ||
| scripts | ||
| src | ||
| themes | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| index.ts | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Code::Stats Readme
Get dynamically generated Code::Stats stats on your readmes!
Features
Profile Card
Options
| Option Name | Description |
|---|---|
| hide | Hide specific line, eg: &hide=xp or &hide=xp,recent_xp |
| show_icons | Shows icons before each lines eg: &show_icons |
| hide_rank | Hide the rank circle eg: &hide_rank |
| line_height | Change the line Height of each lines, eg: &line_height=45 |
| icon_color | Change the icons color, eg: &icon_color=123456&show_icons |
| text_color | Change the text colors, eg: &text_color=123456 |
History Card
Options
| Option Name | Description |
|---|---|
| layout | Change the layout to the horizontal one ex: &layout=horizontal |
| height | Change the height of the card Only on horizontal layout ex: &height=400Default: 300 |
| width | Change the width of the card Only on vertical layout ex: &width=TypeScriptDefault: 500 |
| title | Change the title of the card ex: &title=History |
| days_count | Change the number of days shown ex: &days_count=7 Default: 14 |
| reverse_order | Reverse the order of the days ex: &reverse_order |
| hide | Hide specifics languages and put them in Others ex: &hide=TypeScript |
| language_count | Change the number of languages shown before going to Others ex: &language_count=3defaults: 8 |
| text_color | Change the text colors ex: &text_color=654321 |
Top Languages Card
Options
| Option Name | Description |
|---|---|
| hide | Hide Specific language ex: &hide=TypeScript or &hide=TypeScript,TypeScript%20(JSX) |
| language_count | Change the number of languages shown before going to Others ex: &language_count=3defaults: 8 |
| card_width | Hide the rank circle ex: &card_width=600defaults: 300 |
| layout | Make the layout more compact ex: &layout=compact |
| text_color | Cange the text colors ex: &text_color=654321 |
Common Options
| Options Name | Description |
|---|---|
| title_color | Change the title color ex: &title_color=654321 |
| bg_color | Change the background color ex: &bg_color=654321 |
| hide_border | Hide the border ex: &hide_border |
| hide_title | Hide the title ex: &hide_border |
| theme | See #themes |
| cache_seconds | set the cache header manually (min: 1800, max: 86400) ex: &cache_seconds=86400Default: 1800 or 30 minutes |
| title | CHange the cards title. eg: &title=My Code::Stats |
Themes
With inbuilt themes you can customize the look of the card without doing any manual customization.
Use ?theme=THEME_NAME parameter like so :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
You can checkout the theme config file!
Development
Both ways will create a webserver that listens on port 3000.
Docker
docker build . --tag your-tag
docker run your-tag
NPM
npm ci
npm run build
npm run start