Skip to content

Commit 72c3d5f

Browse files
authored
Misc docs improvements (#577)
1 parent a9ee306 commit 72c3d5f

File tree

6 files changed

+15
-26
lines changed

6 files changed

+15
-26
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ and [custom functions](https://handsontable.github.io/hyperformula/guide/custom-
3737
- Demos
3838
- [JavaScript](https://handsontable.github.io/hyperformula/guide/demo.html)
3939
- [React](https://handsontable.github.io/hyperformula/guide/integration-with-react.html)
40-
- [Vue.js](https://handsontable.github.io/hyperformula/guide/integration-with-vue.html)
41-
- [Angular.js](https://handsontable.github.io/hyperformula/guide/integration-with-angular.html)
40+
- [Vue](https://handsontable.github.io/hyperformula/guide/integration-with-vue.html)
41+
- [Angular](https://handsontable.github.io/hyperformula/guide/integration-with-angular.html)
4242
- [Installation](https://handsontable.github.io/hyperformula/guide/client-side-installation.html)
4343
- [Basic usage](https://handsontable.github.io/hyperformula/guide/basic-usage.html)
4444
- [API Reference](https://handsontable.github.io/hyperformula/api/)

docs/.vuepress/config.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ const HyperFormula = require('../../dist/hyperformula.full');
44
const fs = require('fs');
55
const path = require('path');
66

7+
const searchPattern = new RegExp('^/api', 'i');
8+
79
module.exports = {
810
title: 'HyperFormula (v' + HyperFormula.version + ')',
911
description: 'HyperFormula is an open-source, high-performance calculation engine for spreadsheets and web applications.',
@@ -37,6 +39,12 @@ module.exports = {
3739
$page.buildDate = HyperFormula.buildDate
3840
// inject current HF releaseDate as {{ $page.releaseDate }} variable
3941
$page.releaseDate = HyperFormula.releaseDate
42+
// inject current HF function count as {{ $page.functionsCount }} variable
43+
$page.functionsCount = HyperFormula.getRegisteredFunctionNames('enGB').length
44+
45+
if (searchPattern.test($page.path)) {
46+
$page.frontmatter.editLink = false
47+
}
4048
},
4149
chainMarkdown (config) {
4250
// inject custom markdown highlight with our aliases to formula syntax
@@ -101,7 +109,7 @@ module.exports = {
101109
path: '/api/',
102110
},
103111
{
104-
title: 'HyperFormula',
112+
title: 'HyperFormula Class',
105113
path: '/api/classes/hyperformula',
106114
collapsable: true,
107115
},
@@ -141,7 +149,6 @@ module.exports = {
141149
['/guide/dependencies', 'Dependencies'],
142150
['/guide/licensing', 'Licensing'],
143151
['/guide/changelog', 'Changelog'],
144-
['/guide/roadmap', 'Roadmap'],
145152
['/guide/support', 'Support'],
146153
]
147154
},

docs/.vuepress/styles/index.styl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,6 @@ table {
8585
border: none;
8686
border-bottom: 1px solid #dfe2e5;
8787
line-height: 1.7;
88+
text-align: left;
8889
}
8990
}

docs/guide/built-in-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ because a spreadsheet is probably the most universal software
1010
ever created. We wanted the same flexibility for HyperFormula
1111
but without the constraints of the spreadsheet UI.
1212

13-
All implemented functions are grouped into 8 different categories:
13+
The latest version of HyperFormula has an extensive collection of **{{ $page.functionsCount }}** functions grouped into 9 categories:
1414

1515
* Date and time
1616
* Engineering
@@ -57,7 +57,7 @@ lets you design your own [custom functions](custom-functions).
5757
5858
<br><br>
5959

60-
## List of available functions
60+
## List of available functions (total: {{ $page.functionsCount }})
6161

6262
| Function ID | Category | Description | Syntax |
6363
| :--- | :--- | :--- | :--- |

docs/guide/custom-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class CountHF extends FunctionPlugin {
6060
## Aliases
6161

6262
If you want to include aliases (multiple names to a single implemented function) inside the plugin,
63-
you can do this by the static `aliases` property.
63+
you can do this with the static `aliases` property.
6464

6565
The property is keyed with aliases IDs, and with values being aliased functions IDs.
6666

docs/guide/roadmap.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)