You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,19 +36,19 @@ ignite new ExampleSite
36
36
37
37
Once installed, the command-line tool is helpful for running a local web server for testing and for building your project.
38
38
39
-
> [!Tip]
40
-
> Using the Ignite tool to run a local web server is the best way to preview your site.
41
-
42
-
Alternatively, you can bring Ignite into an existing project using Swift Package Manager by adding a package dependency for <https://github.com/twostraws/Ignite>.
43
-
44
-
Once that completes, import Ignite into your Swift code wherever needed:
45
-
46
-
```swift
47
-
importIgnite
39
+
To build your example site, run these commands:
40
+
```shell
41
+
cd ExampleSite
42
+
ignite build
48
43
```
49
44
45
+
That creates a new folder called Build with the site files. Now you can preview it. (For more details on how to build, see "Using the command-line tool" below.)
46
+
50
47
## Important: Previewing your site
51
48
49
+
> [!Tip]
50
+
> Using the Ignite tool to run a local web server is the best way to preview your site.
51
+
52
52
Once you've built your site and are ready to see how it looks, do *not* just double-click one of the files in Finder. This will open the file directly in your browser, which means it won't know how to locate the rest of your site – the stylesheets, JavaScript code, etc – so it will not display correctly.
53
53
54
54
Instead, the best way to preview your site is using the Ignite CLI tool, which you installed in Getting Started above:
@@ -150,6 +150,14 @@ Ignite sites are just Swift package, but they use a specific folder structure to
150
150
151
151
This folder structure is already in place in the [Ignite Starter Template](https://github.com/twostraws/IgniteStarter) repository, and I recommend you start with that.
152
152
153
+
Alternatively, you can bring Ignite into an existing project using Swift Package Manager by adding a package dependency for <https://github.com/twostraws/Ignite>.
154
+
155
+
Once that completes, import Ignite into your Swift code wherever needed:
156
+
157
+
```swift
158
+
importIgnite
159
+
```
160
+
153
161
## Create a layout to render Markdown files
154
162
155
163
Adding Markdown files to **Content** will render these to HTML pages and include them in **Build** with their respective folder structure, minus the **Content** part.
0 commit comments