RandomSec/docs
allanaaa 6edfda79a3
Docs > Expressions (#3264)
* Update expressions.md

No function reference just yet, nor text for Jython and Clojure. This will all likely be split out into multiple pages, but for now, it's all one for ease of discussion.

* Adding some functions structure for discussion

* Small tweaks

* Accept edits first, duh

* Shortening shorthands

* Update expressions.md

* Tweaks forever

* Adding table of math functions

* Typos, Clojure examples, cross() recipe

* Formatting and language

* Misc clarifications

* Splitting the pages

* Update grelfunctions.md

* Formatting + resolving comments

* Removing a table hack

* Update grelfunctions.md

* Update grelfunctions.md

* Update grelfunctions.md

* Added columnName

* Update grelfunctions.md

* Update grelfunctions.md

* Update expressions.md

* Forgot to fix some links when I split the pages

* Regex updates
2020-12-02 13:08:00 +01:00
..
docs Docs > Expressions (#3264) 2020-12-02 13:08:00 +01:00
src Style modifications in docusaurus docs to fix #3329 (#3365) 2020-11-29 16:25:58 +01:00
static Docs > Expressions (#3264) 2020-12-02 13:08:00 +01:00
.gitignore begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
docusaurus.config.js Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00
package.json Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00
README.md begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
sidebars.js Docs > Expressions (#3264) 2020-12-02 13:08:00 +01:00
yarn.lock Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00

How to build these docs

We use Docusaurus 2 for our docs, a modern static website generator.

Requirements

Assuming you have Node.js installed (which includes npm), you can install Docusaurus with:

You will need to install Yarn before you can build the site.

npm install -g yarn

Installation

Once you have installed yarn, navigate to docs directory & set-up the dependencies.

cd docs
yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.