Skip to content

Commit

Permalink
Refactor most of the docs generation into a seperate repo
Browse files Browse the repository at this point in the history
  • Loading branch information
neil-lindquist committed Jul 18, 2019
1 parent efb28fa commit 8c1b6f9
Show file tree
Hide file tree
Showing 34 changed files with 39 additions and 2,608 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# generated documentation
docs-bin

# SLIMA's temp file
repl.lisp-repl
5 changes: 4 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ cache:
install:
- curl -L https://raw.githubusercontent.com/roswell/roswell/release/scripts/install-for-ci.sh | sh
- ros install neil-lindquist/ci-utils
- ros install neil-lindquist/doc-site-generator
# CCL's default asdf is slightly too old, so need to use a newer version
- mkdir -p ~/common-lisp
- if [ "$LISP" == "ccl-bin" ]; then git clone https://gitlab.common-lisp.net/asdf/asdf.git ~/common-lisp; fi
Expand All @@ -41,7 +42,9 @@ script:
- run-fiveam -e t -l linear-programming-test linear-programming-test:linear-programming

before_deploy:
- roswell/generate-docs.ros
- copy-site-base docs docs-bin
- echo "The documentation page for the linear-programming Common Lisp library." | make-gh-page README.md docs-bin/index.md
- roswell/generate-API-docs.ros

deploy:
provider: pages
Expand Down
17 changes: 0 additions & 17 deletions NOTICE.md

This file was deleted.

174 changes: 4 additions & 170 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
# --- General options --- #

# url is the full website URL
# baseurl is the website's URL without the hostname

# If you are building a simple GitHub user page (https://username.github.io) then use these settings:
#url: "https://neil-lindquist.github.io"
#baseurl: ""

# If you are building a GitHub project page then use these settings:
url: "http://neil-lindquist.github.io/linear-programming"
baseurl: "/linear-programming"

# Of course don't forget to change the username and projectname to YOUR username and project

# Name of website
title: linear-programming

Expand All @@ -28,43 +18,14 @@ navbar-links:

# Image to show in the navigation bar - image must be a square (width = height)
# Remove this parameter if you don't want an image in the navbar
#avatar: "/img/avatar.png"
# avatar: "/img/avatar.png"

# If you want to have an image logo in the top-left corner instead of the title text,
# then specify the following parameter
# title-img: /path/to/image

# --- Blog options --- #
paginate_path: "/blog/page:num/"

# --- Background colour/image options --- #

# Personalize the colors in your website. Colour values can be any valid CSS colour

navbar-col: "#F5F5F5"
navbar-text-col: "#404040"
navbar-children-col: "#F5F5F5"
page-col: "#FFFFFF"
link-col: "#008AFF"
hover-col: "#0085A1"
footer-col: "#F5F5F5"
footer-text-col: "#777777"
footer-link-col: "#404040"

# Alternatively, the navbar, footer, and page background can be set to use background images
# instead of colour

# navbar-img: "/img/bgimage.png"
# footer-img: "/img/bgimage.png"
# page-img: "/img/bgimage.png"

# --- Footer options --- #

# Change all these values or delete the ones you don't want.
# Important: you must keep the "name" parameter, everything else you can remove
author:
name: Neil Lindquist

# Select your active Social Network Links.
# Uncomment the links you want to show in the footer and add your information to each link.
# You can reorder the items to define the link order.
Expand All @@ -90,69 +51,9 @@ social-network-links:
# twitch: yourname
# yelp: yourname

# Select which share links to show in posts
share-links-active:
# twitter: true
# facebook: true
# linkedin: true

# How to display the link to the website in the footer
# Remove this if you don't want a link in the footer
url-pretty: "neil-lindquist.github.io"

# --- Web Statistics Section --- #

# Fill in your Google Analytics gtag.js ID to track your website using gtag
gtag: "UA-130011901-1"

# Fill in your Google Analytics ID to track your website using GA
google_analytics: "UA-130011901-1"

# Google Tag Manager ID
#gtm: ""

# Matomo (aka Piwik) Web statistics
# Uncomment the following section to enable Matomo. The opt-out parameter controls
# whether or not you want to allow users to opt out of tracking.

#matomo:
# site_id: "9"
# uri: "demo.wiki.pro"
# opt-out: true

# --- Comments --- #

# Fill in your Disqus shortname (NOT the userid) if you want to support Disqus comments
# disqus: ""

# To use Facebook Comments, fill in a Facebook App ID
# fb_comment_id: ""

# --- Misc --- #

# Facebook App ID
# fb_app_id: ""

# Excerpt Word Length
# Truncates the excerpt to the specified number of words on the index page
excerpt_length: 50

# Character used to separate site title and description in HTML document title
# and RSS feed title
title-separator: " - "

# --- Don't need to touch anything below here (but you can if you want) --- #

# Output options (more information on Jekyll's site)
timezone: " America/Chicago"
markdown: kramdown
highlighter: rouge
permalink: /:year-:month-:day-:title/
paginate: 5

kramdown:
input: GFM
hard_wrap: false
# Exclude these files from production site
exclude:

# Default YAML values (more information on Jekyll's site)
defaults:
Expand All @@ -169,71 +70,4 @@ defaults:
path: "" # all files
values:
layout: "page"
show-avatar: true

# Use tags index page and make tags on each post clickable
link-tags: true

# Exclude these files from production site
exclude:
- LICENSE
- README.md

# prose.io config
prose:
rooturl: '_posts'
media: 'img'
ignore:
- 404.html
- LICENSE
- feed.xml
- _config.yml
- /_layouts
- /_includes
- /css
- /img
- /js
metadata:
_posts:
- name: "layout"
field:
element: "hidden"
value: "post"
- name: "title"
field:
element: "text"
label: "Post title"
placeholder: "Title"
alterable: true
- name: "subtitle"
field:
element: "textarea"
label: "Subtitle"
placeholder: "A description of your post."
alterable: true
- name: "date"
field:
element: "text"
label: "Date"
help: "Enter date of post."
placeholder: "yyyy-mm-dd"
alterable: true
- name: "image"
field:
element: "text"
label: "Image"
help: "Add a thumbnail image to your post."
placeholder: "Thumbnail"
alterable: true
- name: "published"
field:
element: "checkbox"
label: "Publish"
help: "Check to publish post, uncheck to hide."

plugins:
- jekyll-paginate
- jekyll-sitemap

# Beautiful Jekyll / Dean Attali
# 2fc73a3a967e97599c9763d05e564189
show-avatar: false
107 changes: 0 additions & 107 deletions docs/_data/SocialNetworks.yml

This file was deleted.

17 changes: 0 additions & 17 deletions docs/_includes/disqus.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_includes/ext-css.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_includes/ext-js.html

This file was deleted.

Loading

0 comments on commit 8c1b6f9

Please sign in to comment.