Skip to content

Added Table of Contents auto-generation to README. #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Added Table of Contents auto-generation to README. #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afc978c
Added Tocer gem.
bkuhlmann May 14, 2017
f11aa5e
Added Tocer project configuration.
bkuhlmann May 14, 2017
ea750d6
Added Table of Contents to README.
bkuhlmann May 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .tocerrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:label: "## Table of Contents"
11 changes: 11 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,16 @@ GEM
thor (>= 0.18.1, < 2.0)
rainbow (2.2.1)
rake (12.0.0)
refinements (4.1.0)
rubocop (0.47.1)
parser (>= 2.3.3.1, < 3.0)
powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.7)
unicode-display_width (~> 1.0, >= 1.0.1)
ruby-progressbar (1.8.1)
runcom (0.6.0)
refinements (~> 4.1)
sprockets (3.7.1)
concurrent-ruby (~> 1.0)
rack (> 1, < 3)
Expand All @@ -114,7 +117,14 @@ GEM
activesupport (>= 4.0)
sprockets (>= 3.0.0)
thor (0.19.4)
thor_plus (5.1.0)
thor (~> 0.19)
thread_safe (0.3.6)
tocer (5.0.0)
refinements (~> 4.1)
runcom (~> 0.6)
thor (~> 0.19)
thor_plus (~> 5.1)
tzinfo (1.2.2)
thread_safe (~> 0.1)
unicode-display_width (1.1.3)
Expand All @@ -131,6 +141,7 @@ DEPENDENCIES
rails
rake (>= 11.1)
rubocop (>= 0.47)
tocer (~> 5.0)
webpacker!

BUNDLED WITH
Expand Down
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,29 @@ JavaScript frameworks.
It's designed to work with Rails 5.1+ and makes use of the [Yarn](https://yarnpkg.com) dependency management
that's been made default from that version forward.

<!-- Tocer[start]: Auto-generated, don't remove. -->

## Table of Contents

- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Binstubs](#binstubs)
- [Configuration](#configuration)
- [Advanced Configuration](#advanced-configuration)
- [Linking to static assets](#linking-to-static-assets)
- [Getting asset path](#getting-asset-path)
- [Deployment](#deployment)
- [Linking to sprockets assets](#linking-to-sprockets-assets)
- [Ready for React](#ready-for-react)
- [Ready for Angular with TypeScript](#ready-for-angular-with-typescript)
- [Ready for Vue](#ready-for-vue)
- [Ready for Elm](#ready-for-elm)
- [Troubleshooting](#troubleshooting)
- [Wishlist](#wishlist)
- [License](#license)

<!-- Tocer[finish]: Auto-generated, don't remove. -->

## Prerequisites

* Ruby 2.2+
Expand Down
1 change: 1 addition & 0 deletions webpacker.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Gem::Specification.new do |s|
s.add_dependency "railties", ">= 4.2"

s.add_development_dependency "bundler", "~> 1.12"
s.add_development_dependency "tocer", "~> 5.0"

s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- test/*`.split("\n")
Expand Down