diff --git a/README.md b/README.md index 8038532..3d56114 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,5 @@ There are a few common sub-headings that you can choose to use when writing a to - Also known as. Similies for the topic. An article on 'Node.JS' might list 'Node'. Don't write things that aren't necessary for a non-technical person to grasp the topic. This is in no way meant to replace official documentation, Wikipedia or Stack Overflow. + +Many of the files in the `_topic` folder at the moment are either empty placeholders or rushed first attempts. Please do take a look if you feel that you can contribute. \ No newline at end of file diff --git a/_config.yaml b/_config.yaml index 01c3d46..0596d35 100644 --- a/_config.yaml +++ b/_config.yaml @@ -1,6 +1,6 @@ title: Jargonthing - +github: https://github.com/ collections: topic: output: true - permalink: /:name \ No newline at end of file + permalink: /:name diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 0000000..cadd740 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,14 @@ +
+ \ No newline at end of file + + + \ No newline at end of file diff --git a/_includes/search.html b/_includes/search.html new file mode 100644 index 0000000..1bd3b85 --- /dev/null +++ b/_includes/search.html @@ -0,0 +1,10 @@ +
+ + +
\ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index e7a7ea7..6f586b1 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -6,28 +6,31 @@ - + + {{ site.title }} - {% include nav.html %} - -
- +
{{ content }} - -
-
-

- Contribute on GitHub. -

+ {% include footer.html %} + - - - + + + + + \ No newline at end of file diff --git a/_layouts/home.html b/_layouts/home.html index 4d6a0ae..06d81fa 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -2,6 +2,6 @@ layout: default --- -
- {{ content }} -
\ No newline at end of file +
+ +{{ content }} \ No newline at end of file diff --git a/_layouts/topic.html b/_layouts/topic.html index 4d6a0ae..3ce450d 100644 --- a/_layouts/topic.html +++ b/_layouts/topic.html @@ -1,7 +1,19 @@ --- layout: default --- +{% include nav.html %} + +
+
+
+

{{ page.title }}

+ {% if page.website %} + {{ page.website }} + {% endif %} +
+
+
{{ content }}
\ No newline at end of file diff --git a/_topic/angularjs.markdown b/_topic/angularjs.markdown index 473dbd5..cec16ed 100644 --- a/_topic/angularjs.markdown +++ b/_topic/angularjs.markdown @@ -3,7 +3,5 @@ layout: topic title: "Angular.JS" --- -# Angular.JS - This topic is awaiting content. Open a pull request to contribute! diff --git a/_topic/authorization.markdown b/_topic/authorization.markdown index 10c6d82..3565a71 100644 --- a/_topic/authorization.markdown +++ b/_topic/authorization.markdown @@ -3,5 +3,4 @@ layout: topic title: "Authorization" --- -# Authorization - +Authorization is the process of ensuring that a user is allowed to perform a specfic action. diff --git a/_topic/browser.markdown b/_topic/browser.markdown index b31a31d..e7f4b3d 100644 --- a/_topic/browser.markdown +++ b/_topic/browser.markdown @@ -3,5 +3,3 @@ layout: topic title: "Web Browser" --- -# Web Browser - diff --git a/_topic/client-server.markdown b/_topic/client-server.markdown index 0aeb564..97828cf 100644 --- a/_topic/client-server.markdown +++ b/_topic/client-server.markdown @@ -3,8 +3,6 @@ layout: topic title: "Client-Server" --- -# Client-Server - 'Client-Server' is a model for communication between two computer systems. The role of the Server is to receive requests and act upon them, by either returning or modifying data. The role of the Client is to create and send these requests to the Server, often on behalf of a human user. The Server is usually responsible for securing access to sensitive data and ensuring that all requests from Clients are properly [authorized](authorization) and validated. The Client is usually responsible for receiving input directly from a user in the form of mouse clicks or keyboard typing and formatting this data into a form that the Server can understand. diff --git a/_topic/desktop-application.markdown b/_topic/desktop-application.markdown index 92239fa..3b41b3a 100644 --- a/_topic/desktop-application.markdown +++ b/_topic/desktop-application.markdown @@ -2,6 +2,3 @@ layout: topic title: "Desktop Application" --- - -# Desktop Application - diff --git a/_topic/dotnet-core.markdown b/_topic/dotnet-core.markdown index 281eb03..0560468 100644 --- a/_topic/dotnet-core.markdown +++ b/_topic/dotnet-core.markdown @@ -1,9 +1,8 @@ --- layout: topic title: ".NET Core" +website: https://dotnet.github.io/ --- -# .NET Core - This topic is awaiting content. Open a pull request to contribute! diff --git a/_topic/dotnet-framework.markdown b/_topic/dotnet-framework.markdown index 0fd57d9..2f60960 100644 --- a/_topic/dotnet-framework.markdown +++ b/_topic/dotnet-framework.markdown @@ -1,11 +1,10 @@ --- layout: topic title: ".NET Framework" +website: https://www.microsoft.com/net/ --- -# .NET Framework - -The .NET Framework is a [software framework](framework) that was originally designed and released by [Microsoft](microsoft) in 2001. It originally could be used to build [desktop applications](desktop-application) for the [Windows](windows) operating system but has since expanded to be used to build [server-side](client-server) [web](web-application) and [mobile](mobile-application) applications. +The .NET Framework is a [software framework](framework) that first released by [Microsoft](microsoft) in 2001. It originally could be used to build [desktop applications](desktop-application) for the [Windows](windows) operating system but has since expanded to be used to build [server-side](client-server) [web](web-application) and [mobile](mobile-application) applications. diff --git a/_topic/framework.markdown b/_topic/framework.markdown index dd5003d..7dbe483 100644 --- a/_topic/framework.markdown +++ b/_topic/framework.markdown @@ -3,8 +3,6 @@ layout: topic title: "Software Framework" --- -# Software Framework - A Software Framework is a set of tools, libraries and methodologies that are designed to make it easier for [developers](developer) to build systems. Frameworks differ from [libraries](library) in that they often expect the developers using them to follow certain patterns and methodologies when using them. #### Examples diff --git a/_topic/javascript.markdown b/_topic/javascript.markdown index 1f1fd4d..3287e9f 100644 --- a/_topic/javascript.markdown +++ b/_topic/javascript.markdown @@ -3,6 +3,12 @@ layout: topic title: "JavaScript" --- -# JavaScript +JavaScript is a [programming language](programming-language) that was originally created to allow developers to write code that could be run in a [Web Browser](web-browser). It was first released in 1994 by the company Netscape. It has since become one of the most ubiquotous programming languages in the world and can be found executing including Web Browsers, [IoT Devices](iot-devices) and Mobile Phones. -JavaScript is a [programming language](programming-language) that was created to allow enable richer experiences on the web by enabling web developers to write code that can run in a [client](client-server) [browser](web-browser). \ No newline at end of file +It is the programming language usd in the popular [Node.JS](nodejs) [runtime](runtime). + +It is not related to the programming language, [Java](java). + +## Similar to +- [Python](python) +- [TypeScript](typescript) diff --git a/_topic/library.markdown b/_topic/library.markdown index f713168..1b39f80 100644 --- a/_topic/library.markdown +++ b/_topic/library.markdown @@ -3,8 +3,6 @@ layout: topic title: "Software Library" --- -# Software Library - A Software Library is a small collection of components that are designed to be used as part of a larger system. The components in a library usually share a single cohesive theme and do not try to dictate how they should be used by other systems. #### Differs to diff --git a/_topic/microsoft.markdown b/_topic/microsoft.markdown index 893fdc1..a82ef7f 100644 --- a/_topic/microsoft.markdown +++ b/_topic/microsoft.markdown @@ -3,5 +3,3 @@ layout: topic title: "Microsoft" --- -# Microsoft - diff --git a/_topic/mobile-application.markdown b/_topic/mobile-application.markdown index 37d07a5..95ecc6f 100644 --- a/_topic/mobile-application.markdown +++ b/_topic/mobile-application.markdown @@ -3,5 +3,3 @@ layout: topic title: "Mobile Application" --- -# Mobile Application - diff --git a/_topic/nodejs.markdown b/_topic/nodejs.markdown index 4b76d9b..305da29 100644 --- a/_topic/nodejs.markdown +++ b/_topic/nodejs.markdown @@ -3,7 +3,5 @@ layout: topic title: "Node.JS" --- -# Node.JS - -This topic is awaiting content. Open a pull request to contribute! +Node.JS is a platform that enables developers to build [server-side](client-server) applications using [JavaScript](javascript) as the programming language. diff --git a/_topic/npm.markdown b/_topic/npm.markdown index f7aaa9c..6e4c3d7 100644 --- a/_topic/npm.markdown +++ b/_topic/npm.markdown @@ -3,7 +3,5 @@ layout: topic title: "NPM" --- -# NPM - This topic is awaiting content. Open a pull request to contribute! diff --git a/_topic/package-manager.markdown b/_topic/package-manager.markdown index 5b7468e..051a9a3 100644 --- a/_topic/package-manager.markdown +++ b/_topic/package-manager.markdown @@ -3,7 +3,5 @@ layout: topic title: "Package Manager" --- -# Package Manager - This topic is awaiting content. Open a pull request to contribute! diff --git a/_topic/python.markdown b/_topic/python.markdown new file mode 100644 index 0000000..3c9eaae --- /dev/null +++ b/_topic/python.markdown @@ -0,0 +1,11 @@ +--- +layout: topic +title: "Python" +website: "https://pythonlang.org" +snipper: "Python is a programming languge known for its simplicity and wide range of uses." +--- + +Python is a [programming language](programming-language) that was originally created in 1994 by Someone. It is known for its wide range of uses including [Web Applications](web-applications), Data Science and Education. The simplicity of Python means that is is often used to teach introductory programming courses. + +## Similar To +- [JavaScript](javascript) diff --git a/_topic/react.markdown b/_topic/react.markdown index 0aeb258..e2fa560 100644 --- a/_topic/react.markdown +++ b/_topic/react.markdown @@ -3,8 +3,6 @@ layout: topic title: "React.JS" --- -# React.JS - React.JS is a [library](/library) for building [user interfaces](ui). It utilises [JavaScript](javascript) and a special [syntax](syntax) for describing a heirachy of components that make up the interface called JSX. It was originally released in 2013 by [Facebook](https://facebook.com) as [open-source software](oss). It can be used to create [user interfaces](ui) for [web browsers](web-browser) and for mobile devices. diff --git a/_topic/runtime.markdown b/_topic/runtime.markdown new file mode 100644 index 0000000..742011b --- /dev/null +++ b/_topic/runtime.markdown @@ -0,0 +1,8 @@ +--- +layout: topic +title: "Software Runtime" +snippet: "" +--- + +This topic is awaiting content. Open a pull request to contribute! + diff --git a/_topic/typescript.markdown b/_topic/typescript.markdown new file mode 100644 index 0000000..6fd698c --- /dev/null +++ b/_topic/typescript.markdown @@ -0,0 +1,8 @@ +--- +layout: topic +title: "TypeScript" +snippet: "" +--- + +This topic is awaiting content. Open a pull request to contribute! + diff --git a/_topic/web-application.markdown b/_topic/web-application.markdown index 39f493a..4574845 100644 --- a/_topic/web-application.markdown +++ b/_topic/web-application.markdown @@ -3,5 +3,4 @@ layout: topic title: "Web Application" --- -# Web Applications diff --git a/_topic/windows.markdown b/_topic/windows.markdown index db0d9f8..5e9bd4d 100644 --- a/_topic/windows.markdown +++ b/_topic/windows.markdown @@ -3,5 +3,3 @@ layout: topic title: "Windows" --- -# Windows - diff --git a/assets/bootstrap.min.css b/assets/css/bootstrap.min.css similarity index 100% rename from assets/bootstrap.min.css rename to assets/css/bootstrap.min.css diff --git a/assets/css/site.css b/assets/css/site.css new file mode 100644 index 0000000..243ee91 --- /dev/null +++ b/assets/css/site.css @@ -0,0 +1,34 @@ +#site-form { + position: relative; +} + +#results-container { + position: absolute; + top: 100%; + padding-left: 28px; + padding-right: 10px; + padding-bottom: 0px; + background: white; + z-index: 1; +} + +.header-nav { + height: 10px; +} + +.body-content { + min-height: 300px; +} + +.footer-github-image { + height: 30px; +} + +.footer-github { + background: white; + border-radius: 50%; +} + +hr { + margin-bottom: 0; +} \ No newline at end of file diff --git a/assets/img/mark-github-512.png b/assets/img/mark-github-512.png new file mode 100644 index 0000000..05cf7bb Binary files /dev/null and b/assets/img/mark-github-512.png differ diff --git a/assets/bootstrap.min.js b/assets/js/bootstrap.min.js similarity index 100% rename from assets/bootstrap.min.js rename to assets/js/bootstrap.min.js diff --git a/assets/jquery-3.3.1.slim.min.js b/assets/js/jquery-3.3.1.slim.min.js similarity index 100% rename from assets/jquery-3.3.1.slim.min.js rename to assets/js/jquery-3.3.1.slim.min.js diff --git a/assets/popper.min.js b/assets/js/popper.js/1.14.3/umd/popper.min.js similarity index 100% rename from assets/popper.min.js rename to assets/js/popper.js/1.14.3/umd/popper.min.js diff --git a/assets/js/simple-jekyll-search.min.js b/assets/js/simple-jekyll-search.min.js new file mode 100644 index 0000000..3aeba15 --- /dev/null +++ b/assets/js/simple-jekyll-search.min.js @@ -0,0 +1,6 @@ +/*! + * Simple-Jekyll-Search v1.6.3 (https://github.com/christian-fei/Simple-Jekyll-Search) + * Copyright 2015-2018, Christian Fei + * Licensed under the MIT License. + */ +!function(){"use strict";var s={load:function(e,t){var n=window.XMLHttpRequest?new window.XMLHttpRequest:new ActiveXObject("Microsoft.XMLHTTP");n.open("GET",e,!0),n.onreadystatechange=(r=n,i=t,function(){if(4===r.readyState&&200===r.status)try{i(null,JSON.parse(r.responseText))}catch(e){i(e,null)}}),n.send();var r,i}};var n=function(e,t){var n=t.length,r=e.length;if(n{title}',templateMiddleware:Function.prototype,sortMiddleware:function(){return 0},noResultsText:"No results found",limit:10,fuzzy:!1,exclude:[]},i=["searchInput","resultsContainer","json"],o=function e(t){if(n=t,!(n&&"undefined"!=typeof n.required&&n.required instanceof Array))throw new Error("-- OptionsValidator: required options missing");var n;if(!(this instanceof e))return new e(t);var r=t.required;this.getRequiredOptions=function(){return r},this.validate=function(t){var n=[];return r.forEach(function(e){"undefined"==typeof t[e]&&n.push(e)}),n}}({required:i});function a(e){r.success(e),f.put(e),r.searchInput.addEventListener("keyup",function(e){var t;t=e.which,-1===[13,16,20,37,38,39,40,91].indexOf(t)&&(n(),l(e.target.value))})}function n(){r.resultsContainer.innerHTML=""}function u(e){r.resultsContainer.innerHTML+=e}function l(e){var t;(t=e)&&0 -

{{ site.title }}

+
+
+

{{ site.title }}

-

A Jargonbuster for people that work with techies.

+

A Jargonbuster for people who work with techies.

+
+ +
+
+ {% include search.html %} +
+
-
-
-
- -
- +
+

Recently added

+ +
+
+
+ {% for item in site.topic %} + {{ item.title }} + {% endfor %}
-
- -
-
- -

Topics

- -
-
-
- {% for item in site.topic %} - {{ item.title }} - {% endfor %} -
-
\ No newline at end of file diff --git a/new_topic.sh b/new_topic.sh index b9c7773..dd7ad5c 100755 --- a/new_topic.sh +++ b/new_topic.sh @@ -1,9 +1,9 @@ echo '--- layout: topic title: "'$(echo $2)'" +snippet: "" +website: "" --- -# '$(echo $2)' - This topic is awaiting content. Open a pull request to contribute! ' >> ./_topic/$1.markdown diff --git a/search.json b/search.json new file mode 100644 index 0000000..bd7fb98 --- /dev/null +++ b/search.json @@ -0,0 +1,12 @@ +--- +layout: null +--- +[ + {% for topic in site.topic %} + { + "title": "{{ topic.title | escape }}", + "url": "{{ topic.url }}", + "snippet": "{{ topic.snippet }}" + } {% unless forloop.last %},{% endunless %} + {% endfor %} +] \ No newline at end of file