Skip to content

Commit 8598566

Browse files
DannyvdSluijsDannyvdSluijs
committed
Add initial draft on documentation site
1 parent f90bdb5 commit 8598566

File tree

33 files changed

+6640
-1
lines changed

33 files changed

+6640
-1
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/node_modules/
2+
/.DS_Store
3+
/.jekyll-cache
4+
/_site

‎.idea/JsonMapper.iml

+5-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/dictionaries/danny.xml

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎_config.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
defaults:
2+
- scope:
3+
path: ""
4+
values:
5+
layout: "default"
6+
- scope:
7+
path: "assets/images"
8+
values:
9+
image: true
10+
11+
exclude:
12+
- "*.config.js"
13+
- "package*.json"
14+
- assets
15+
- node_modules
16+
- .idea
17+

‎_data/manifest.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"docs.css": "./dist/docs.css",
3+
"docs.js": "./dist/docs.js"
4+
}

‎_data/menu.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
General:
2+
Introduction: '/docs/'
3+
Architecture: '/docs/architecture/'
4+
5+
Usage:
6+
Setup: '/docs/usage/setup/'
7+
8+
Guides:
9+
Laravel Usage: '/docs/guides/laravel-usage/'
10+
Symfony Usage: '/docs/guides/symfony-usage/'
11+
Deterministic Code: '/docs/guides/deterministic-programming/'
12+
13+
Middleware:
14+
DocBlockAnnotations: '/docs/middleware/doc-block-annotations/'
15+
TypedProperties: '/docs/middleware/typed-properties/'
16+
FullQualifiedClassNameResolver: '/docs/middleware/full-qualified-class-name-resolver/'
17+
18+
Advanced Usage:
19+
Performance: '/docs/advanced/performance/'

‎_layouts/default.html

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<link rel="stylesheet" href="/{{ site.data.manifest['docs.css'] }}">
5+
<title>JsonMapper</title>
6+
</head>
7+
<body class="text-base pt-12 leading-normal bg-grey-100 p-4">
8+
<div class="flex flex-col">
9+
<header class="">
10+
<a href="/">
11+
<img src="/images/jsonmapper.png"/>
12+
</a>
13+
</header>
14+
<main class="">
15+
<div class="flex flex-row h-screen">
16+
<nav class="w-1/6 pl-2 pt-2 hidden md:block">
17+
{% for section in site.data.menu %}
18+
<h2 class="tracking-wide text-xs leading-loose uppercase">{{ section[0] }}</h2>
19+
<ul class="list-reset pl-4 mb-6">
20+
{% for link in section[1] %}
21+
<li class="tracking-wide text-md rounded">
22+
<a href="{{ link[1] }}">{{ link[0] }}</a>
23+
</li>
24+
{% endfor %}
25+
</ul>
26+
{% endfor %}
27+
</nav>
28+
<article class="w-full m-4">
29+
<h1 class="mb-4">{{ page.title }}</h1>
30+
{{ content }}
31+
</article>
32+
</div>
33+
</main>
34+
<footer>
35+
36+
</footer>
37+
</div>
38+
</body>
39+
</html>

‎android-chrome-192x192.png

9.96 KB
Loading

‎android-chrome-512x512.png

32.4 KB
Loading

‎apple-touch-icon.png

8.88 KB
Loading

‎assets/index.css

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@tailwind base;
2+
@tailwind components;
3+
@tailwind utilities;

‎dist/docs.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/docs.js

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
/******/ (function(modules) { // webpackBootstrap
2+
/******/ // The module cache
3+
/******/ var installedModules = {};
4+
/******/
5+
/******/ // The require function
6+
/******/ function __webpack_require__(moduleId) {
7+
/******/
8+
/******/ // Check if module is in cache
9+
/******/ if(installedModules[moduleId]) {
10+
/******/ return installedModules[moduleId].exports;
11+
/******/ }
12+
/******/ // Create a new module (and put it into the cache)
13+
/******/ var module = installedModules[moduleId] = {
14+
/******/ i: moduleId,
15+
/******/ l: false,
16+
/******/ exports: {}
17+
/******/ };
18+
/******/
19+
/******/ // Execute the module function
20+
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
21+
/******/
22+
/******/ // Flag the module as loaded
23+
/******/ module.l = true;
24+
/******/
25+
/******/ // Return the exports of the module
26+
/******/ return module.exports;
27+
/******/ }
28+
/******/
29+
/******/
30+
/******/ // expose the modules object (__webpack_modules__)
31+
/******/ __webpack_require__.m = modules;
32+
/******/
33+
/******/ // expose the module cache
34+
/******/ __webpack_require__.c = installedModules;
35+
/******/
36+
/******/ // define getter function for harmony exports
37+
/******/ __webpack_require__.d = function(exports, name, getter) {
38+
/******/ if(!__webpack_require__.o(exports, name)) {
39+
/******/ Object.defineProperty(exports, name, { enumerable: true, get: getter });
40+
/******/ }
41+
/******/ };
42+
/******/
43+
/******/ // define __esModule on exports
44+
/******/ __webpack_require__.r = function(exports) {
45+
/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
46+
/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
47+
/******/ }
48+
/******/ Object.defineProperty(exports, '__esModule', { value: true });
49+
/******/ };
50+
/******/
51+
/******/ // create a fake namespace object
52+
/******/ // mode & 1: value is a module id, require it
53+
/******/ // mode & 2: merge all properties of value into the ns
54+
/******/ // mode & 4: return value when already ns object
55+
/******/ // mode & 8|1: behave like require
56+
/******/ __webpack_require__.t = function(value, mode) {
57+
/******/ if(mode & 1) value = __webpack_require__(value);
58+
/******/ if(mode & 8) return value;
59+
/******/ if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;
60+
/******/ var ns = Object.create(null);
61+
/******/ __webpack_require__.r(ns);
62+
/******/ Object.defineProperty(ns, 'default', { enumerable: true, value: value });
63+
/******/ if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));
64+
/******/ return ns;
65+
/******/ };
66+
/******/
67+
/******/ // getDefaultExport function for compatibility with non-harmony modules
68+
/******/ __webpack_require__.n = function(module) {
69+
/******/ var getter = module && module.__esModule ?
70+
/******/ function getDefault() { return module['default']; } :
71+
/******/ function getModuleExports() { return module; };
72+
/******/ __webpack_require__.d(getter, 'a', getter);
73+
/******/ return getter;
74+
/******/ };
75+
/******/
76+
/******/ // Object.prototype.hasOwnProperty.call
77+
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
78+
/******/
79+
/******/ // __webpack_public_path__
80+
/******/ __webpack_require__.p = "";
81+
/******/
82+
/******/
83+
/******/ // Load entry module and return exports
84+
/******/ return __webpack_require__(__webpack_require__.s = "./assets/index.css");
85+
/******/ })
86+
/************************************************************************/
87+
/******/ ({
88+
89+
/***/ "./assets/index.css":
90+
/*!**************************!*\
91+
!*** ./assets/index.css ***!
92+
\**************************/
93+
/*! no static exports found */
94+
/***/ (function(module, exports, __webpack_require__) {
95+
96+
eval("// extracted by mini-css-extract-plugin\n if(false) { var cssReload; }\n \n\n//# sourceURL=webpack:///./assets/index.css?");
97+
98+
/***/ })
99+
100+
/******/ });

‎docs/advanced/performance/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/advanced/performance
3+
title: Performance
4+
---
5+
6+
Something about performance

‎docs/architecture/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/architecture
3+
title: Architecture
4+
---
5+
6+
Something about the architecture

‎docs/guides/deterministic-programming/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/guides/deterministic-programming/
3+
title: Deterministic programming
4+
---
5+
6+
Something about Deterministic programming

‎docs/guides/laravel-usage/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/guides/laravel-usage/
3+
title: Laravel usage
4+
---
5+
6+
Something about Laravel usage

‎docs/guides/symfony-usage/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/guides/symfony-usage/
3+
title: Symfony usage
4+
---
5+
6+
Something about Symfony usage

‎docs/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
permalink: /docs
3+
title: Introduction
4+
---
5+
6+
JsonMapper offers a easy to use library which amins to avoid the tedious and repetitive task of mapping a JSON reponse
7+
to a PHP model.

‎docs/middleware/doc-block-annotations/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/middleware/doc-block-annotations/
3+
title: DocBlock annotations
4+
---
5+
6+
Something about DocBlock annotations

‎docs/middleware/full-qualified-class-name-resolver/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/middleware/full-qualified-class-name-resolver/
3+
title: Full qualified class name resolver
4+
---
5+
6+
Something about Full qualified class name resolver

‎docs/middleware/typed-properties/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/middleware/typed-properties/
3+
title: Typed properties
4+
---
5+
6+
Something about Typed properties

‎docs/usage/setup/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
permalink: /docs/usage/setup
3+
title: Setup
4+
---
5+
6+
Something about setup

‎favicon-16x16.png

550 Bytes
Loading

‎favicon-32x32.png

1.1 KB
Loading

‎favicon.ico

15 KB
Binary file not shown.

‎images/jsonmapper.png

11.4 KB
Loading

‎index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
permalink: /
3+
title: Welcome to my docs
4+
---
5+
6+
# Hello
7+
8+
Welcome to my docs!

0 commit comments

Comments
 (0)