-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.md.rkt
30 lines (18 loc) · 1.31 KB
/
README.md.rkt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#lang scribble/text
Eventually I'm going to turn this documentation page into some kind of [Gatsby](https://www.gatsbyjs.com/) enabled static site.
If you're looking at this repo directly, that day is not today.
# Technologies used here
The first approach for this site is to use Github as a (decent!) markdown rendering platform for individual files.
Some files are preprocessed via [Racket's scribble library](https://docs.racket-lang.org/scribble/index.html) documentation tool. Then I checkin / commit the generated files so they are viewed via its rendered Github generated markdown
# TODO:
- [x] generate ToCs for those super long pages...
- [ ] my refenence backlink stuff doesn't work with markdown-toc <-- ends up coming out as `>` in the reference. Boo.
# File Index
Because if you're looking at the file list in Github, it's hard to know if a file is the (good to view / generated one) vs the Scribble pre-processed slightly messy original file. It looks like it shows up twice...
@(define (display-file-list)
(map
(lambda (current) (string-append " * [" (path->string current) "](https://github.com/rwilcox/my-learnings-docs/blob/master/" (path->string current) ")\n"))
(filter
(lambda (current) (string-suffix? (path->string current) ".md"))
(directory-list "." #:build? #f))))
@(display-file-list)