Skip to content

Commit efb33b5

Browse files
authored
Update README.md
1 parent 3c14200 commit efb33b5

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ gems further up in the list to your Gemfile.
134134
There are a couple of ways to use YARD. The first is via command-line, and the
135135
second is the Rake task.
136136

137-
**1. yard Command-line Tool**
137+
### 1. yard Command-line Tool
138138

139139
YARD comes packaged with a executable named `yard` which can control the many
140140
functions of YARD, including generating documentation, graphs running the YARD
@@ -147,7 +147,7 @@ $ yard --help
147147
Plugins can also add commands to the `yard` executable to provide extra
148148
functionality.
149149

150-
### Generating Documentation
150+
#### Generating Documentation
151151

152152
<span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
153153

@@ -194,7 +194,7 @@ switches separated by whitespace (newlines or space) to pass to yardoc whenever
194194
it is run. A full overview of the `.yardopts` file can be found in
195195
[YARD::CLI::Yardoc](https://rubydoc.info/gems/yard/YARD/CLI/Yardoc#label-Options+File+-28.yardopts-29).
196196

197-
### Queries
197+
#### Queries
198198

199199
The `yardoc` tool also supports a `--query` argument to only include objects
200200
that match a certain data or meta-data query. The query syntax is Ruby, though a
@@ -221,7 +221,7 @@ following two lines both check for the existence of a return and param tag:
221221

222222
For more information about the query syntax, see the {YARD::Verifier} class.
223223

224-
**2. Rake Task**
224+
### 2. Rake Task
225225

226226
The second most obvious is to generate docs via a Rake task. You can do this by
227227
adding the following to your `Rakefile`:
@@ -247,7 +247,7 @@ environment variable:
247247
$ rake yard OPTS='--any --extra --opts'
248248
```
249249

250-
**3. `yri` RI Implementation**
250+
### 3. `yri` RI Implementation
251251

252252
The yri binary will use the cached .yardoc database to give you quick ri-style
253253
access to your documentation. It's way faster than ri but currently does not
@@ -271,7 +271,7 @@ $ yard gems
271271
If you don't have sudo access, it will write these files to your `~/.yard`
272272
directory. `yri` will also cache lookups there.
273273

274-
**4. `yard server` Documentation Server**
274+
### 4. `yard server` Documentation Server
275275

276276
The `yard server` command serves documentation for a local project or all
277277
installed RubyGems. To serve documentation for a project you are working on,
@@ -285,14 +285,14 @@ And the project inside the current directory will be parsed (if the source has
285285
not yet been scanned by YARD) and served at
286286
[http://localhost:8808](http://localhost:8808).
287287

288-
### Live Reloading
288+
#### Live Reloading
289289

290290
If you want to serve documentation on a project while you document it so that
291291
you can preview the results, simply pass `--reload` (`-r`) to the above command
292292
and YARD will reload any changed files on each request. This will allow you to
293293
change any documentation in the source and refresh to see the new contents.
294294

295-
### Serving Gems
295+
#### Serving Gems
296296

297297
To serve documentation for all installed gems, call:
298298

@@ -304,7 +304,7 @@ This will also automatically build documentation for any gems that have not been
304304
previously scanned. Note that in this case there will be a slight delay between
305305
the first request of a newly parsed gem.
306306

307-
**5. `yard graph` Graphviz Generator**
307+
### 5. `yard graph` Graphviz Generator
308308

309309
You can use `yard graph` to generate dot graphs of your code. This, of course,
310310
requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default

0 commit comments

Comments
 (0)