diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 23 |
1 files changed, 12 insertions, 11 deletions
| @@ -1,11 +1,4 @@ | |||
| 1 | --- | 1 | # notYetAnotherWiki |
| 2 | favicon: cartdave_favicon.png | ||
| 3 | pagetitle: "notYetAnotherWiki" | ||
| 4 | author: onefang | ||
| 5 | feedatom: https://sledjhamr.org/cgit/notYetAnotherWiki/atom | ||
| 6 | history: https://sledjhamr.org/cgit/notYetAnotherWiki/log/index.md | ||
| 7 | sourcecode: https://sledjhamr.org/cgit/notYetAnotherWiki/ | ||
| 8 | --- | ||
| 9 | 2 | ||
| 10 | notYetAnotherWiki is not another wiki, at least not yet. It'll be much | 3 | notYetAnotherWiki is not another wiki, at least not yet. It'll be much |
| 11 | more than that, eventually. | 4 | more than that, eventually. |
| @@ -59,22 +52,30 @@ the useful info that makes it's way into the system one way or another. | |||
| 59 | Someone comes into your chat system, asking for help, within minutes | 52 | Someone comes into your chat system, asking for help, within minutes |
| 60 | people are helping out and come up with a working solution. After a few | 53 | people are helping out and come up with a working solution. After a few |
| 61 | other people turn up with the same problem, the existing conversations | 54 | other people turn up with the same problem, the existing conversations |
| 62 | are moved to the decumentation section, where the original participants | 55 | are moved to the documentation section, where the original participants |
| 63 | and others can polish it into proper documentation about solving what has | 56 | and others can polish it into proper documentation about solving what has |
| 64 | suddenly become a common problem. Every one knows where to find it, on | 57 | suddenly become a common problem. Every one knows where to find it, on |
| 65 | the one system. They can chat about it, on the one system. | 58 | the one system. They can chat about it, on the one system. |
| 66 | 59 | ||
| 67 | ## What does it do already? | 60 | ## What does it do already? |
| 68 | 61 | ||
| 69 | Currently it'll scan the current directory and subdirectories looking for | 62 | Currently it'll scan the current folder and sub folders looking for |
| 70 | .md files in CommonMark syntax. This should cover some MarkDown | 63 | .md files in CommonMark syntax. This should cover some MarkDown |
| 71 | variations. Then it produces .HTML files converted from these .md files, | 64 | variations. Then it produces .HTML files converted from these .md files, |
| 72 | and links them all together into a web site. | 65 | and links them all together into a web site. |
| 73 | 66 | ||
| 67 | Any .md file that is just the beginning metadata block doesn't get | ||
| 68 | rendered into HTML, but is global metadata for this folder and subs, | ||
| 69 | though the subs can override this with their own metadata.md files. | ||
| 70 | |||
| 74 | git is used to store the .md files, and provides edit history. Added on | 71 | git is used to store the .md files, and provides edit history. Added on |
| 75 | the footer is links to cgit, which is used to store the files in git on | 72 | the footer is links to cgit, which is used to store the files in git on |
| 76 | your server. This provides acces to the source code, history, and ATOM | 73 | your server. This provides acces to the source code, history, and ATOM |
| 77 | feed for the site. | 74 | feed for the site. |
| 78 | 75 | ||
| 79 | It can also scan an external directory and merge that with the current | 76 | It can also scan an external folder and merge that with the current |
| 80 | one, but this isn't tested yet. | 77 | one, but this isn't tested yet. |
| 78 | |||
| 79 | ## other stuff | ||
| 80 | |||
| 81 | The font femkeklaver.ttf was used for making the nYAW logo. | ||