Skip to content

Commit aefdb47

Browse files
authored
Add diagram library (#548)
* checking in file * add instructions, exclude .sketch files
1 parent 58e4205 commit aefdb47

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ source: ./src
77

88
permalink: /:categories/:title/
99

10-
exclude: ['js', '_site']
10+
exclude: ['js', '_site' '*.sketch']
1111
# Build settings
1212
markdown: kramdown
1313
highlighter: rouge

diagram-library/howto.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# The Segment Diagram Library
2+
3+
The library file was built by Tonik, and is in Sketch. You'll need a Sketch license to edit the file.
4+
5+
You can also export the file, or diagrams you make with it, to `.svg` format for storage.
6+
7+
## Using the Library
8+
9+
1. To create a new diagram, open the library file in Sketch and **make a copy**.
10+
2. Rename the copy so it's specific to the project you're working on.
11+
*Don't* use the base library file itself for this.
12+
3. Optionally, save the Sketch file to the `images` directory for the file you'll be putting this diagram in, so it's easier to find later.
13+
Jekyll _should_ exclude Sketch files from the build. You can also name the file with an underscore as the first character to exclude it from the build. If you have more than 3 sketch files for a specific doc, you can create a folder called `_src` in the `images` directory.
14+
4. In Sketch, create a new Artboard. (Press A and drag a box on the screen.)
15+
This is the canvas where you'll put items from the library, and represents an area that you can export as an image.
16+
5. Make your diagram! Don't forget to save frequently.
17+
6. When you're ready to export, select the artboard by clicking it in the left layers navigation, and find the **Export** panel at the end of the right tool pane.
18+
7. Select **1x** (Apple Retina screens support 2x but it's not necessary) and `.png` format.
19+
8. At the VERY end of the panel, find the **Export Selected** button, and click it.
20+
9. If needed, move the resulting `.png` file to the correct `images` directory.
21+
10. Add the new diagram in the markdown file, and run a test build to make sure your diagram is legible on the page!
22+
23+
That's it!
24+
25+
When you need to update it, you can reopen the sketch file, make your changes, and re-export.

0 commit comments

Comments
 (0)