To contribute dataset information, fill in template.md
, rename based on the dataset title, place into _databases
, and submit via a pull request.
Files in the root directory:
- page not found file:
404.html
, - configuration files:
Gemfile
(Gem dependencies),Makefile
,CNAME
,.gitignore
,_config.local.yml
,_config.yml
, - content:
board.md
,create.md
,index.md
,info.md
,policies.md
, - database entry template:
template.md
, - deprecated:
DATA.md
(MathDB data in Markdown) andsplit_data.py
(a script converting old data to YAML).
_data
: YAML files for navigation, badges and tags._databases
: the contents of the MathBases database, one file for each entry._includes
and_layouts
: page templates._topics
: short expository articles about data in various areas of mathematics (currently just for algebraic geometry)._assets
: currently just the css overrides.
To generate web pages locally for preview, you need Jekyll, which needs Ruby (along with an extensive array of subordinate Ruby packages).
-
Install Ruby (and possibly ruby-dev)
-
Bootstrap
gem install bundler --user-install
export GEM_HOME=$HOME/.gem
bundle install
- Run
make serve
to run locally
- Install Ruby:
-
on a Mac, you can use Homebrew with
brew install ruby echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.zshrc source ~/.zshrc
-
of you can follow https://www.moncefbelyamani.com/the-definitive-guide-to-installing-ruby-gems-on-a-mac/
-
Clone this repo
-
Run
make bootstrap
(this only needs to be done once on your system).
To do this locally, you can instead do the following.
gem install bundler --user-install
bundle config set --local path '/home/YOURUSERNAME/.local/share/gem'
bundle install
or a similar path of your choosing.
- Run
make serve
to run locally