Skip to content

Commit eb84fc5

Browse files
committed
docs: 📝 Small changes
1 parent f95f54d commit eb84fc5

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

docs/index.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<style>
2+
.md-content .md-typeset h1 { display: none; }
3+
</style>
4+
15
<div align="center">
26
<img src="assets/logo.png"/>
37
</div>
@@ -40,11 +44,16 @@ it’s time to refactor_.
4044
* **A non-controversial code metric**: Most developers agree longer functions
4145
are harder to maintain
4246
* **Actionable results**: There's always a refactoring possible to make
43-
functions smaller.
44-
* **Runs everywhere**: Fits your development workflow, whether it's in a build
45-
pipeline, a pre-commit hook, or standalone.
47+
functions smaller
48+
* **Runs everywhere**: Fits your development workflow, whether it's in a [build
49+
pipeline](getting-started/development-workflow.md), a [pre-commit
50+
hook](getting-started/development-workflow.md#pre-commit-hook), or
51+
[standalone](getting-started/standalone-usage.md)
4652
* **Covers many languages**: A single tool for all your projects
47-
* **Sane defaults**: Zero configuration, but allows customization.
53+
* **Sane defaults**: Zero configuration, but allows customization
54+
* **Low threshold to get started**: Can only check new or modified code, so
55+
even if you have a backlog of technical debt, you can start using Code Limit
56+
today
4857

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

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ markdown_extensions:
3737
- attr_list
3838
- pymdownx.snippets
3939
nav:
40-
- 'index.md'
40+
- Code Limit: 'index.md'
4141
- 'why-function-length.md'
4242
- Getting Started:
4343
- 'getting-started/development-workflow.md'

0 commit comments

Comments
 (0)