Skip to content

Commit

Permalink
documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruce Hauman committed Dec 20, 2018
1 parent 554d107 commit e056c84
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 12 deletions.
4 changes: 2 additions & 2 deletions doc/figwheel-main-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ If you don't want to use the default host page you will need to create
a your own host page for it. See
https://figwheel.org/docs/your_own_page for help.

This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
and [devcards](https://github.com/bhauman/devcards) to your workflow.

Also keep in mind that you can insert extra behavior with `:preloads`
Expand Down Expand Up @@ -700,4 +700,4 @@ Default: 8000
If you need to watch files with polling instead of FS events. This can
be useful for certain docker environments.

:hawk-options {:watcher :polling}
:hawk-options {:watcher :polling}
2 changes: 1 addition & 1 deletion docs/_includes/main-api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A `build` arg can be either:
```clojure
{
:id "dev" ; a required string build id
:options {:main hello-world.core} ; a required map of cljs compile options
:options {:main 'hello-world.core} ; a required map of cljs compile options
:config {:watch-dirs ["src"]} ; an options map of figwheel.main config options
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/config-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ Default: true
A String that specifies the target directory component of the path
where figwheel.main outputs compiled ClojureScript

The default `:output-dir` is composed of:
The default [`:output-dir`](https://figwheel.org/docs/compile_config) is composed of:

[[:target-dir]]/public/cljs-out/[[build-id]]

Expand Down Expand Up @@ -498,7 +498,7 @@ If you don't want to use the default host page you will need to create
a your own host page for it. See
https://figwheel.org/docs/your_own_page for help.

This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
and [devcards](https://github.com/bhauman/devcards) to your workflow.

Also keep in mind that you can insert extra behavior with `:preloads`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h4 id="devcljsedn">dev.cljs.edn</h4>
<p>In <code>dev.cljs.edn</code>:</p>

<div class="language-clojure highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>{<span style="color:#A60">:main</span> hello.core}
<div class="code"><pre>{<span style="color:#A60">:main</span> hello-world.core}
</pre></div>
</div>
</div>
Expand All @@ -48,14 +48,14 @@ <h4 id="devcljsedn">dev.cljs.edn</h4>
that you can configure in this file. For most cases however all you
will need is the above.</p>

<h3 id="srchellocorecljs">src/hello/core.cljs</h3>
<h3 id="srchello_worldcorecljs">src/hello_world/core.cljs</h3>

<p>Next let’s create an initial ClojureScript file for our project.</p>

<p>In <code>src/hello/core.cljs</code> put:</p>
<p>In <code>src/hello_world/core.cljs</code> put:</p>

<div class="language-clojure highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>(<span style="color:#080;font-weight:bold">ns</span> <span style="color:#707;font-weight:bold">hello.core</span>)
<div class="code"><pre>(<span style="color:#080;font-weight:bold">ns</span> <span style="color:#707;font-weight:bold">hello-world.core</span>)

(enable-console-print!)

Expand Down Expand Up @@ -127,4 +127,3 @@ <h2 id="building-the-build">Building the build</h2>

<p>From here you will be able to edit the ClojureScript file and have it
hot loaded into the browser on save.</p>

4 changes: 2 additions & 2 deletions src/figwheel/main/schema/config.clj
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ Default: true
"A String that specifies the target directory component of the path
where figwheel.main outputs compiled ClojureScript
The default `:output-dir` is composed of:
The default [`:output-dir`](https://figwheel.org/docs/compile_config) is composed of:
[[:target-dir]]/public/cljs-out/[[build-id]]
Expand Down Expand Up @@ -561,7 +561,7 @@ If you don't want to use the default host page you will need to create
a your own host page for it. See
https://figwheel.org/docs/your_own_page for help.
This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
This feature is perfect for adding [cljs-test-display](https://github.com/bhauman/cljs-test-display)
and [devcards](https://github.com/bhauman/devcards) to your workflow.
Also keep in mind that you can insert extra behavior with `:preloads`
Expand Down

0 comments on commit e056c84

Please sign in to comment.