Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation polishing - stage 4 #408

Merged
merged 14 commits into from
Jun 24, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reorganized website
Co-Authored-By: Wojciech Czerniak <wojciech.czerniak@gmail.com>
  • Loading branch information
wszymanski and wojciechczerniak committed Jun 24, 2020
commit 7a8be60ec18a5065e7b411c2acb882deaaab6fcd
72 changes: 36 additions & 36 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,52 @@ module.exports = {
// indexName: '<INDEX_NAME>'
// },
nav: [
{ text: 'Guide', link: '/guide/welcome.md' },
{ text: 'Guide', link: '/' },
{ text: 'API Reference', link: '/api/' },
],
displayAllHeaders: false, // collapse other pages
activeHeaderLinks: true,
sidebarDepth: 1,
sidebar: {
'/guide/': [
'/api/': [
{
title: 'Introduction',
path: '/api/',
},
{
title: 'HyperFormula',
path: '/api/classes/hyperformula',
collapsable: true,
},
{
title: 'Event Types',
path: '/api/interfaces/listeners',
alias: '/api/events',
collapsable: true,
},
{
title: 'Configuration Options',
path: '/api/interfaces/configparams',
collapsable: true,
},
{
title: 'Error Types',
collapsable: true,
children: fs.readdirSync(path.join(__dirname, '../api/classes'))
.filter((n) => n.match(/.*error\.md$/))
.map(f => `/api/classes/${f}`)
},
{
title: 'Globals',
path: '/api/globals',
},
],
'/': [
{
title: 'Introduction',
collapsable: false,
children: [
['/guide/welcome', 'Welcome'],
['/', 'Welcome'],
['/guide/demo', 'Demo'],
]
},
Expand Down Expand Up @@ -194,39 +227,6 @@ module.exports = {
]
}
],
'/api/': [
{
title: 'Introduction',
path: '/api/',
},
{
title: 'HyperFormula',
path: '/api/classes/hyperformula',
collapsable: true,
},
{
title: 'Event Types',
path: '/api/interfaces/listeners',
alias: '/api/events',
collapsable: true,
},
{
title: 'Configuration Options',
path: '/api/interfaces/configparams',
collapsable: true,
},
{
title: 'Error Types',
collapsable: true,
children: fs.readdirSync(path.join(__dirname, '../api/classes'))
.filter((n) => n.match(/.*error\.md$/))
.map(f => `/api/classes/${f}`)
},
{
title: 'Globals',
path: '/api/globals',
},
],
},
}
};
5 changes: 5 additions & 0 deletions docs/.vuepress/enhanceApp.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export default ({ router }) => {
router.addRoutes([
{ path: '/guide/', redirect: '/' }
])
}
66 changes: 66 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
description: HyperFormula® - Complex Calculations Made Easy
---

# Welcome

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/JJXUmACTDdk?controls=0"
frameborder="0"
allow="accelerometer;
encrypted-media;
gyroscope;
picture-in-picture"
allowfullscreen>
</iframe>
wszymanski marked this conversation as resolved.
Show resolved Hide resolved

### What is HyperFormula?

HyperFormula is an open-source **calculation engine** that allows you to perform Excel-like calculations in your business applications. HyperFormula is written mostly in TypeScript and supports all major JavaScript frameworks like [Vue](integration-with-vue.md) and [React](integration-with-react.md) \(Angular is coming soon\). You can use it in a browser or as a service with Node.js as your back-end technology.

It comes with a built-in [library of functions](built-in-functions.md) grouped into different categories, such as Math and trigonometry, Engineering, Statistical, Financial, and Logical. The functions use A1 notation and are compatible with popular spreadsheet software like Excel or Google Sheets, which means that you can easily transfer the data and formulas between them.

HyperFormula covers most user-triggered actions such as [CRUD operations](basic-operations), [undo/redo](undo-redo.md), and [clipboard operations](clipboard-operations.md). It also supports the use of cross-sheet references, [named expressions](named-ranges.md), [different data types](types-of-values.md), and [custom functions](custom-functions).

### What can it be used for?

HyperFormula doesn't assume any existing user interface \(UI\), which makes it a great general-purpose library that can be used in various business applications. Here are some ideas on what you can build with HyperFormula:

* Smart documents
* Educational apps
* Computation notebooks
* Data grid components
* Business logic builders
* Forms and form builders
* Spreadsheets
* Online calculators
* Low connectivity apps

### Core features

The features that HyperFormula offers make it a flexible and easy to use tool for many types of software.

* High-speed formula calculations
* A library of built-in functions available in 16 languages
* Support for cross-sheet references
* Support for undo/redo
* Support for copy/cut/paste
* Support for wildcard characters
* Works with frameworks such as [React](integration-with-react.md) and [Vue](integration-with-vue.md)
* Written in TypeScript and extensively tested
* Uses GPU acceleration for better performance
* Function syntax compatible with Excel and Google Sheets
* Triple license: AGPL/Non-commercial/Commercial
* Actively maintained and supported by the [Handsontable](https://handsontable.com/) team

### Useful resources

* [Basic usage](basic-usage.md)
* [Configuration options](configuration-options.md)
* [Built-in functions](built-in-functions.md)
* [Custom functions](custom-functions)
* [Key concepts](key-concepts.md)
* [Performance](performance.md)