Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

simplefoc/simplefoc.github.io

Repository files navigation

simplefoc.github.io

Documentation website for SimpleFOCproject

Running the site using anaconda environement

Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/

First create the new anaconda environmnet using the environment.yamlfile

conda env create -f environement.yaml
conda activate simpledocs

Once in the environment simpledocs install jekyll

gem install jekyll bundler

Then install necessary jekyll dependencies of the simplefoc docs:

# Optionally specify "--path /some/other/dir" to avoid needing root.
bundle install

And you're ready to go!

Just make sure that whenever you open your terminal to generate the website to activate the conda environment:

conda activate simpledocs

Generating the website

To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:

bundle exec jekyll serve

Since the site is quiet large sometimes the --incremental flag helps with faster execution

bundle exec jekyll serve --incremental

Search Functionality

Search UX includes a full results page at /search/. Press Enter in the search box (without selecting a single result) or click View all results in the dropdown to open it.

Olddocs generating

  1. Add the library version to the index.md
  2. modify the _config.yaml
    • url: "http://olddocs.simplefoc.com"
    • baseurl: "v2.2.3"
  3. run bundle exec jekyll build
  4. in _site you have the generated html

About

documentation website for SimpleFOCproject

Resources

Readme

Stars

Watchers

Forks

Packages

Contributors