1
0
mirror of https://github.com/esp8266/Arduino.git synced 2025-06-13 13:01:55 +03:00

Documentation update

This commit is contained in:
Ivan Grokhotkov
2015-11-23 20:21:16 +03:00
parent 3d268108fc
commit 866921c54a
9 changed files with 642 additions and 519 deletions

View File

@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
#
# @file esp8266-arudino-doc.bash
@ -11,15 +11,16 @@
# Packages needed by this script:
# * linux commands: ln, cp, mkdir, rm, wget
# * git
# * jekyll
#
# ruby libraries:
# ruby gems:
# * jekyll
# * redcarpet
# * rb-pygments
#
# gem install [lib]
#
set -e
# some variable definitions
tmp_path=$1
@ -37,11 +38,11 @@ echo " version: "$version
echo " release date: "$release_date
echo " build date: "$build_date
echo " put documentation into: "$destination_path
echo "documentatino template url: "$doc_template_url
echo "documentation template url: "$doc_template_url
echo " url: "$url
# continue?
read -e -p "Dou you wish to continue (y/n)? " -n 1 -i "y" decision
read -e -p "Dou you wish to continue (y/n)? " -n 1 decision
if echo "$decision" | grep -iq "^y" ;then
echo "okay"
else
@ -99,8 +100,10 @@ ln -s ../$version _site
# add subtitle and basurl
echo "url: \"$url\"" > _config_local.yml
echo "subtitle: \"ver. $version, built on $build_date\"" >> _config_local.yml
echo "version: $version" >> _config_local.yml
echo "build_date: $build_date" >> _config_local.yml
echo "baseurl: /Arduino/versions/$version" >> _config_local.yml
mv doc/reference_items.yml _data/reference_items.yml
# build with jekyll
jekyll build --config _config.yml,_config_local.yml