Skip to content

Commit

Permalink
docs: 📝 Small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
robvanderleek committed Dec 10, 2024
1 parent f95f54d commit eb84fc5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<style>
.md-content .md-typeset h1 { display: none; }
</style>

<div align="center">
<img src="assets/logo.png"/>
</div>
Expand Down Expand Up @@ -40,11 +44,16 @@ it’s time to refactor_.
* **A non-controversial code metric**: Most developers agree longer functions
are harder to maintain
* **Actionable results**: There's always a refactoring possible to make
functions smaller.
* **Runs everywhere**: Fits your development workflow, whether it's in a build
pipeline, a pre-commit hook, or standalone.
functions smaller
* **Runs everywhere**: Fits your development workflow, whether it's in a [build
pipeline](getting-started/development-workflow.md), a [pre-commit
hook](getting-started/development-workflow.md#pre-commit-hook), or
[standalone](getting-started/standalone-usage.md)
* **Covers many languages**: A single tool for all your projects
* **Sane defaults**: Zero configuration, but allows customization.
* **Sane defaults**: Zero configuration, but allows customization
* **Low threshold to get started**: Can only check new or modified code, so
even if you have a backlog of technical debt, you can start using Code Limit
today

*[functions]: Also called methods or procedures, depending on your programming language

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ markdown_extensions:
- attr_list
- pymdownx.snippets
nav:
- 'index.md'
- Code Limit: 'index.md'
- 'why-function-length.md'
- Getting Started:
- 'getting-started/development-workflow.md'
Expand Down

0 comments on commit eb84fc5

Please sign in to comment.