|
1 |
| -<<<<<<< HEAD |
2 |
| -# k reference card |
3 |
| - |
4 |
| -https://kparc.github.io/ref |
5 |
| - |
6 |
| -An unofficial clickable version of the k help, accessible in the REPL with `\h`. |
7 |
| - |
8 |
| -It provides examples, short recipes, dev progress notes, and links to other resources. |
9 |
| - |
10 |
| -Trial versions of k for macOS and Linux can be downloaded from Anaconda - follow the instructions [here](https://github.com/kparc/kcc/blob/master/README.md#get). |
11 |
| - |
12 |
| -To add a section: |
13 |
| - |
14 |
| -1. Select a word that you'd like to contribute docs for in the quickref |
15 |
| -2. Add it to the `links` array in `index.html` |
16 |
| -3. Search for the string 'template' in `index.html`, and copy it. Add the word as an id to the `h2` or `h3` or `h4` and fill in content beneath it. |
17 |
| - |
18 |
| -Edit the docs by editing `index.html`. |
19 |
| - |
20 |
| -TODO: |
21 |
| - |
22 |
| -* Write more docs |
23 |
| -* Convert to markdown, implement code validation vs. latest release |
24 |
| -* Figure out how to sync `index.html` with changes to the quickref (may need Shakti's help) |
25 |
| -* Tempted to switch to [MkDocs/Material](https://squidfunk.github.io/mkdocs-material/), but want to keep it simple for now |
26 |
| -* Consider [Zig's docs approach](https://ziglang.org/documentation/master/#Introduction) - easily downloaded single file + code samples form part of the test suite |
27 |
| -* Get a better system for dynamically adding links, that can handle a word appearing more than once in the help (eg maybe subsequent mentions become '#list2') |
28 |
| -* Consider moving 'contribute' link to right-hand side of banner (just be wary of impact on small mobile phone screens) |
29 |
| -======= |
30 | 1 | ## Yet another take on the refcard
|
31 | 2 |
|
32 | 3 | ### Features
|
@@ -54,10 +25,5 @@ and serve the `./build/` directory over http
|
54 | 25 | * merge with updated content
|
55 | 26 | * plug in test script
|
56 | 27 | * create a build hook
|
57 |
| -<<<<<<< HEAD |
58 |
| - |
59 |
| ->>>>>>> initial commit |
60 |
| -======= |
61 | 28 | * add some fancy `<meta>` tags like `name` and `description`
|
62 | 29 | * learn [pug](https://naltatis.github.io/jade-syntax-docs/), aka jade, it will take you ~30 minutes, if you want to modify html
|
63 |
| ->>>>>>> updated README |
0 commit comments