Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false

[*.md]
trim_trailing_whitespace = false
29 changes: 29 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Vim
*~
*.sw[p_]

# Sublime Text
*.sublime-project
*.sublime-workspace

# Ruby Gem
*.gem
.bundle
Gemfile.lock
**/vendor/bundle

# Node.js and NPM
node_modules
npm-debug.log*
package-lock.json
codekit-config.json

# macOS
.DS_Store

# Jekyll generated files
.jekyll-cache
.jekyll-metadata
.sass-cache
_asset_bundler_cache
_site
32 changes: 32 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
source 'https://rubygems.org'

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem 'jekyll', '~> 3.6', '>= 3.6.3'

# This is the default theme for new Jekyll sites. You may change this to anything you like.
# gem "minima", "~> 2.0"
gem "minimal-mistakes-jekyll"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
gem "kramdown", ">= 2.3.1"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

gem 'github-pages', group: :jekyll_plugins

gem "webrick", "~> 1.7"
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2013-2020 Michael Rose and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
110 changes: 110 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@

# Laura's convenience command because Reasons
# docs: dev

.PHONY: docs
docs:
bundle exec jekyll serve --force_polling --trace --incremental -H 0.0.0.0 -V

# .PHONY: dev
# dev: node_modules vendor/bundle
# @$(BIN)/concurrently --raw --kill-others -n webpack,jekyll \
# "$(BIN)/webpack --mode=development --watch" \
# "bundle exec jekyll clean && bundle exec jekyll serve --force_polling --trace --incremental -H 0.0.0.0 -V"

.PHONY: intialize-work-dir
intialize-work-dir:
@mkdir -p _site
@chmod -R 777 _site/
@mkdir vendor
@chmod -R 777 vendor/
@bundle install --path=vendor

.PHONY: build
build: node_modules vendor/bundle
@$(BIN)/concurrently --raw --kill-others -n webpack,jekyll \
"$(BIN)/webpack --mode=development --watch" \
"bundle exec jekyll clean && bundle exec jekyll build -V"

# .PHONY: build
# build: node_modules vendor/bundle
# @echo "Jekyll env: ${JEKYLL_ENV}"
# @chown -R jekyll /workdir
# @chmod -R 777 /workdir
# @echo "env: ${JEKYLL_ENV}"
# @$(BIN)/webpack --mode=production
# @JEKYLL_ENV=${JEKYLL_ENV} bundle exec jekyll build --trace
# @if [ '${BUILDKITE_BRANCH}' == 'staging' ]; then echo "updating sitemap.xml..." && sed -i -r 's/segment.com/segment.build/g' ./_site/sitemap.xml; fi;

#
# .PHONY: sidenav
# sidenav: vendor/bundle
# @node scripts/nav.js
#
# # check internal links
# .PHONY: linkcheck-internal
# linkcheck-internal:
# @node scripts/checklinks-internal.js
#
# # check external links
# .PHONY: linkcheck-external
# linkcheck-external:
# @node scripts/checklinks-external.js


.PHONY: env
env:
@sh scripts/env.sh

.PHONY: clean
clean:
@rm -Rf _site
@rm -Rf .sass-cache
@rm -Rf .jekyll-cache
@rm -Rf src/.jekyll-metadata
@rm -f assets/docs.bundle.js

.PHONY: clean-deps
clean-deps:
@rm -Rf vendor
@rm -Rf node_modules

.PHONY: seed
seed:
@cp templates/destinations.example.yml src/_data/catalog/destinations.yml
@cp templates/sources.example.yml src/_data/catalog/sources.yml

.PHONY: node_modules
node_modules: package.json yarn.lock
yarn --frozen-lockfile

.PHONY: vendor/bundle
vendor/bundle:
@export BUNDLE_PATH="vendor/bundle"
@mkdir -p vendor && mkdir -p vendor/bundle
@chmod -R 777 vendor/ Gemfile.lock
@bundle config set --local path 'vendor/bundle'
@bundle install

.PHONY: update
update:
@node scripts/update.js

.PHONY: add-id
add-id:
@node scripts/add_id.js

.PHONY: lint
lint: node_modules
@echo "Checking yml files..."
@npx yamllint src/_data/**/*.yml
# @echo "Checking markdown files..."
# @npx remark ./src --use preset-lint-markdown-style-guide

.PHONY: test
test: lint

.PHONY: check-spelling
check-spelling:
@echo 'Check spelling in markdown files..."
@npx mdspell 'src/**/*.md' -r --en-us -h
Loading