Use rewritten readme as a base for the documentation

4 years ago · cf748514fb
parent fbe968f817
commit cf748514fb
10 changed files with 110 additions and 144 deletions
--- a/docs/assets/js/zzzz-search-data.json
+++ b/docs/assets/js/zzzz-search-data.json
@ -1,72 +0,0 @@
 ---
 permalink: /assets/js/search-data.json
 ---
 {
 {%- assign i = 0 -%}
 {%- assign pages_array = '' | split: '' -%}
 {%- assign pages_array = pages_array | push: site.html_pages -%}
 {%- if site.just_the_docs.collections -%}
  {%- for collection_entry in site.just_the_docs.collections -%}
    {%- assign collection_key = collection_entry[0] -%}
    {%- assign collection_value = collection_entry[1] -%}
    {%- assign collection = site[collection_key] -%}
    {%- if collection_value.search_exclude != true -%}
      {%- assign pages_array = pages_array | push: collection -%}
    {%- endif -%}
  {%- endfor -%}
 {%- endif -%}
 {%- for pages in pages_array -%}
  {%- for page in pages -%}
    {%- if page.title and page.search_exclude != true -%}
      {%- assign page_content = page.content -%}
      {%- assign heading_level = site.search.heading_level | default: 2 -%}
      {%- for j in (2..heading_level) -%}
        {%- assign tag = '<h' | append: j -%}
        {%- assign closing_tag = '</h' | append: j -%}
        {%- assign page_content = page_content | replace: tag, '<h1' | replace: closing_tag, '</h1' -%}
      {%- endfor -%}
      {%- assign parts = page_content | split: '<h1' -%}
      {%- assign title_found = false -%}
      {%- for part in parts offset: 1 -%}
        {%- assign titleAndContent = part | split: '</h1>' -%}
        {%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
        {%- assign title = title[1] | strip_html -%}
        {%- assign content = titleAndContent[1] -%}
        {%- assign url = page.url -%}
        {%- if title == page.title and parts[0] == '' -%}
          {%- assign title_found = true -%}
        {%- else -%}
          {%- assign id = titleAndContent[0] -%}
          {%- assign id = id | split: 'id="' -%}
          {%- if id.size == 2 -%}
            {%- assign id = id[1] -%}
            {%- assign id = id | split: '"' -%}
            {%- assign id = id[0] -%}
            {%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%}
          {%- endif -%}
        {%- endif -%}
  {%- unless i == 0 -%},{%- endunless -%}
  "{{ i }}": {
    "doc": {{ page.title | jsonify }},
    "title": {{ title | jsonify }},
    "content": {{ content | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
    "url": "{{ url | absolute_url }}",
    "relUrl": "{{ url }}"
  }
        {%- assign i = i | plus: 1 -%}
      {%- endfor -%}
      {%- unless title_found -%}
  {%- unless i == 0 -%},{%- endunless -%}
  "{{ i }}": {
    "doc": {{ page.title | jsonify }},
    "title": {{ page.title | jsonify }},
    "content": {{ parts[0] | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
    "url": "{{ page.url | absolute_url }}",
    "relUrl": "{{ page.url }}"
  }
        {%- assign i = i | plus: 1 -%}
      {%- endunless -%}
    {%- endif -%}
  {%- endfor -%}
 {%- endfor %}
 }
--- a/docs/building.markdown
+++ b/docs/building.markdown
@ -1,17 +0,0 @@
 ---
 layout: page
 title: Building
 permalink: /building/
 nav_order: 1
 ---
 # Building
 cmkr requires a C++11 compiler, cmake >= 3.15.
 ```sh
 git clone https://github.com/build-cpp/cmkr
 cd cmkr
 cmake -Bbin
 cmake --build bin --parallel
 ```
--- a/docs/command-line.md
+++ b/docs/command-line.md
@ -0,0 +1,22 @@
 ---
 layout: page
 title: Command line
 permalink: /command-line/
 nav_order: 2
 ---
 ## Command line
 Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line:
 ```
 Usage: cmkr [arguments]
 arguments:
    init    [executable|library|shared|static|interface] Starts a new project in the same directory.
    gen                                                  Generates CMakeLists.txt file.
    build   <extra cmake args>                           Run cmake and build.
    install                                              Run cmake --install. Needs admin privileges.
    clean                                                Clean the build directory.
    help                                                 Show help.
    version                                              Current cmkr version.
 ```
--- a/docs/favicon.ico
+++ b/docs/favicon.ico
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@ -0,0 +1,17 @@
 ---
 layout: page
 title: Getting started
 permalink: /getting-started/
 nav_order: 1
 ---
 ## Getting started
 The easiest way to get started is to use the [cmkr_for_beginners](https://github.com/build-cpp/cmkr_for_beginners) template repository. Either open it in [Gitpod](https://gitpod.io/#https://github.com/build-cpp/cmkr_for_beginners), or clone the repository and run:
 ```sh
 cmake -B build
 cmake --build build
 ```
 Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr) or the [build-cpp organization](https://github.com/build-cpp) for more examples and templates.
--- a/docs/hammer-svgrepo-com.png
+++ b/docs/hammer-svgrepo-com.png
--- a/docs/hammer-svgrepo-com.svg
+++ b/docs/hammer-svgrepo-com.svg
@ -0,0 +1,46 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
 <!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 	 viewBox="0 0 508 508" style="enable-background:new 0 0 508 508;" xml:space="preserve">
 <circle style="fill:#90DFAA;" cx="254" cy="254" r="254"/>
 <rect x="185.183" y="201.014" transform="matrix(-0.6939 -0.7201 0.7201 -0.6939 234.8233 525.8541)" style="fill:#2B3B4E;" width="88.002" height="24"/>
 <g>
 	<path style="fill:#324A5E;" d="M121.6,194.4c-8.8-16.4-2.8-40,14-56.4c50.8-50.4,108.8-52.4,136.8-49.6c4,0.4,3.6,6.4-0.8,8
 		c-11.6,4-21.2,8.8-29.6,14c-25.2,15.2-34,47.6-17.6,64.8l2.8,2.8c1.2,1.2,0.8,3.2-0.8,4.8l-26,25.2c-1.2,1.2-3.2,1.6-4.4,0.8
 		c-8.8-7.2-22-8.4-35.2-4C138.8,212.4,127.2,205.2,121.6,194.4z"/>
 	<path style="fill:#324A5E;" d="M144,228l-18,17.2c-4.8,4.8-12.4,4.4-17.2-0.4l-29.2-30c-4.8-4.8-4.4-12.4,0.4-17.2l18-17.2
 		c4.8-4.8,12.4-4.4,17.2,0.4l29.2,30C149.2,216,148.8,223.6,144,228z"/>
 </g>
 <path style="fill:#FFFFFF;" d="M249.6,240.8l7.2-6.8c5.2-4.8,13.6-4,20,1.6L402,353.2c6.8,6.4,7.6,16,2.4,21.2l-19.6,18.8
 	c-5.6,5.2-15.2,4-21.2-3.2L250.4,260.8C244.8,254.4,244.4,245.6,249.6,240.8z"/>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 <g>
 </g>
 </svg>
--- a/docs/index.markdown
+++ b/docs/index.markdown
@ -1,10 +0,0 @@
 ---
 layout: home
 nav_order: 0
 ---
 # cmkr
 cmkr, pronounced "cmaker", is A CMakeLists.txt generator from TOML.
 See the [cmkr topic](https://github.com/topics/cmkr) for examples. Feel free to add the `cmkr` topic to your projects if you used cmkr!
--- a/docs/index.md
+++ b/docs/index.md
@ -0,0 +1,25 @@
 ---
 layout: home
 title: Index
 nav_order: 0
 ---
 # Index
 `cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io). It was originally created by [Mohammed Alyousef](https://github.com/MoAlyousef).
 **NOTE**: The documentation is currently a work-in-progress due to breaking changes since `0.1.4`. For examples you can check the [cmkr GitHub topic](https://github.com/topics/cmkr) and the [tests](https://github.com/build-cpp/cmkr/tree/main/tests).
 `cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
 ```toml
 [project]
 name = "cmkr_for_beginners"
 description = "A minimal cmkr project."
 [target.hello_world]
 type = "executable"
 sources = ["src/main.cpp"]
 ```
 `cmkr` can bootstrap itself from CMake and consumers of your project do not need to install anything to use it.
--- a/docs/usage.markdown
+++ b/docs/usage.markdown
@ -1,45 +0,0 @@
 ---
 layout: page
 title: Usage
 permalink: /usage/
 nav_order: 2
 ---
 # Usage
 cmkr parses cmake.toml files (using toml11 by Toru Niina) at the project directory. A basic hello world format with the minimum required fields:
 ```toml
 [cmake]
 minimum = "3.15"
 [project]
 name = "app"
 version = "0.1.0"
 [target.app]
 type = "executable"
 sources = ["src/main.cpp"]
 ```
 **NOTE**: The documentation is currently a work-in-progress due to breaking changes since `0.1.4`. For examples you can check the [cmkr topic](https://github.com/topics/cmkr).
 The cmkr executable can be run from the command-line:
 ```
 Usage: cmkr [arguments]
 arguments:
    init    [executable|library|shared|static|interface] Starts a new project in the same directory.
    gen                                                  Generates CMakeLists.txt file.
    build   <extra cmake args>                           Run cmake and build.
    install                                              Run cmake --install. Needs admin privileges.
    clean                                                Clean the build directory.
    help                                                 Show help.
    version                                              Current cmkr version.
 ```
 The build command invokes cmake and the default build-system on your platform (unless a generator is specified), it also accepts extra cmake build arguments:
 ```sh
 cmkr build --config Release 
 ```