UPDATE: Adds CONTRIBUTING guide an documentation
This commit is contained in:
committed by
Nicolás Hatcher Andrés
parent
38e21b9639
commit
614d71b61c
@@ -4,14 +4,9 @@ This repository contains IronCalc's end-user documentation. Here, you can explor
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To manage the documentation, we use [VitePress](https://vitepress.dev/guide/what-is-vitepress), a Static Site Generator (SSG). We also leverage [MathJax v3.0](https://vitepress.dev/guide/markdown#math-equations) for rendering mathematical equations.
|
||||
To manage the documentation, we use [VitePress](https://vitepress.dev/guide/what-is-vitepress), a Static Site Generator (SSG).
|
||||
|
||||
First, ensure you have the following tools installed:
|
||||
|
||||
- **Node.js** (version 18 or higher)
|
||||
- **npm** (comes bundled with Node.js)
|
||||
- A terminal to access the VitePress CLI
|
||||
- A text editor with Markdown syntax support (e.g., VS Code, Cursor)
|
||||
First, ensure you have [nodejs](https://nodejs.org/) installed in your system
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -21,46 +16,25 @@ Start installing the required dependencies by running the following command in y
|
||||
npm install
|
||||
```
|
||||
|
||||
## Build the Project
|
||||
|
||||
Prepare the project for development by building it:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Running the Project
|
||||
|
||||
Start the development server with:
|
||||
Start a development instnace of the documentation server with:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
After running the command, you can view the documentation in your browser at http://localhost:3000 (or the URL displayed in your terminal).
|
||||
After running the command, you can view the documentation in your browser at http://localhost:5173 if the port is available.
|
||||
Making changes to the Markdown will automatically reload your browser.
|
||||
|
||||
## Project Structure
|
||||
|
||||
The documentation is organized as follows:
|
||||
## Build the Project
|
||||
|
||||
```plaintext
|
||||
src
|
||||
├── .vitepress
|
||||
│ ├── theme
|
||||
│ │ └── style.css
|
||||
│ └── config.mts
|
||||
├── features
|
||||
├── functions
|
||||
├── python-bindings
|
||||
└── more
|
||||
To deploy the project:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Notes on the Structure
|
||||
The project will be build in `src/.vitepress/dist`
|
||||
|
||||
- **`.vitepress`**: Contains configuration and theming files for VitePress.
|
||||
- `theme/style.css`: Use this file to customize styles across the documentation.
|
||||
- `config.mts`: Modify this file to change global settings like navigation and layout.
|
||||
- **`features`**: Describes the supported features of IronCalc.
|
||||
- **`functions`**: Includes a comprehensive list of all functions, categorized as supported or unsupported.
|
||||
- **`python-bindings`**: Documentation for using IronCalc with Python.
|
||||
- **`more`**: Additional content or advanced topics related to IronCalc.
|
||||
|
||||
Reference in New Issue
Block a user