Your Content
+ + + +``` + +### Create a brand new doc + +You can create a brand new doc by adding a new entry to `docs/store/topics.js` + +``` JavaScript +/* In the state function there is an array of objects named list. + These entries determine the nav and buttons on the home page of docs. + They are displayed in the nav in order, with an appropriate category. + You can add your new entry to this list */ +export const state = () => ({ + list: [ + { + title: 'Hello World', + category: 'Examples', + description: 'Shows how to create a minimal .NET Core server using Feather HTTP' + }, + //... + { + title: 'SignalR', + category: 'Application Framework', + description: 'How to set up SignalR' + } + ] +}) + +//Your new entry in the list would have this structure: +{ + title: 'Your New Title' + category: 'The Category' + description: 'A small description of your new doc' +} + +``` +Adding this to the `docs/store/topics.js` will set up the routing and add appropriate buttons, but you still haven't created the doc. + +Next you'll create a new file in `docs/pages/examples`. It will be a `.vue` file. Afterwards the explanation for modifying a doc applies. + +Example +``` bash +cd docs/pages/examples +code my-new-docs.vue +#this will open the vue file in vscode for immediate editing. It won't appear in the directory until you save it though +``` + +Once the file is created you can set it up with a template tag. You don't have to create a script tag unless you need it. + +``` html + + +``` + +If you want to write your doc in markdown you can add `lang="md"` to the template + +``` html + +``` + +And that's pretty much all there is to it! Thank you very much for contributing! \ No newline at end of file diff --git a/docs/assets/README.md b/docs/assets/README.md new file mode 100644 index 0000000..34766f9 --- /dev/null +++ b/docs/assets/README.md @@ -0,0 +1,7 @@ +# ASSETS + +**This directory is not required, you can delete it if you don't want to use it.** + +This directory contains your un-compiled assets such as LESS, SASS, or JavaScript. + +More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#webpacked). diff --git a/docs/assets/css/tailwind.css b/docs/assets/css/tailwind.css new file mode 100644 index 0000000..a31e444 --- /dev/null +++ b/docs/assets/css/tailwind.css @@ -0,0 +1,3 @@ +@import 'tailwindcss/base'; +@import 'tailwindcss/components'; +@import 'tailwindcss/utilities'; diff --git a/docs/components/README.md b/docs/components/README.md new file mode 100644 index 0000000..a079f10 --- /dev/null +++ b/docs/components/README.md @@ -0,0 +1,7 @@ +# COMPONENTS + +**This directory is not required, you can delete it if you don't want to use it.** + +The components directory contains your Vue.js Components. + +_Nuxt.js doesn't supercharge these components._ diff --git a/docs/components/card.vue b/docs/components/card.vue new file mode 100644 index 0000000..33c73eb --- /dev/null +++ b/docs/components/card.vue @@ -0,0 +1,30 @@ + +{{description}}
++ Download VS Code +
+ + Once you've installed VS Code you may want to get some extensions so you can have a better editing experience while working with C#. + + ### Download .NET Core 3.1 + + The .NET Core runtime is required in order to run .NET applications. You should get the latest SDK version. You can download using the link below. The link will open in a new tab. + + + + To use the `dotnet new` template, use the following command + + ``` + dotnet new -i FeatherHttp.Templates::{version} --nuget-source https://f.feedz.io/davidfowl/featherhttp/nuget/index.json + ``` + Where version is: + [](https://f.feedz.io/davidfowl/featherhttp/packages/FeatherHttp/latest/download) + + Once you've installed the template, run: + + ``` + dotnet new feather -n {name} + ``` + + This will create a new project using FeatherHttp. + \ No newline at end of file diff --git a/docs/pages/index.vue b/docs/pages/index.vue new file mode 100644 index 0000000..e426451 --- /dev/null +++ b/docs/pages/index.vue @@ -0,0 +1,20 @@ + +## Feather HTTP + +[](https://f.feedz.io/davidfowl/featherhttp/packages/FeatherHttp/latest/download) + +A lightweight low ceremony APIs for ASP.NET Core applications. + +- Built on the same primitives as ASP.NET Core +- Optimized for building HTTP APIs quickly +- Take advantage of existing ASP.NET Core middleware and frameworks + +The strength of FeatherHttp is that, unlike ASP.NET Core MVC or API, web application services are individually configured and therefore FeatherHttp apps require much less ceremony. This means that you only add the services that you plan to use. Further, you can reasonably create an entire functional dotnet web application in a single .cs file. + + + diff --git a/docs/plugins/README.md b/docs/plugins/README.md new file mode 100644 index 0000000..ca1f9d8 --- /dev/null +++ b/docs/plugins/README.md @@ -0,0 +1,7 @@ +# PLUGINS + +**This directory is not required, you can delete it if you don't want to use it.** + +This directory contains Javascript plugins that you want to run before mounting the root Vue.js application. + +More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/plugins). diff --git a/docs/plugins/prism.js b/docs/plugins/prism.js new file mode 100644 index 0000000..e1e6e4c --- /dev/null +++ b/docs/plugins/prism.js @@ -0,0 +1,13 @@ +import Vue from "vue"; +import Prism from "vue-prism-component"; + +import "prismjs"; + +import "prismjs/themes/prism-funky.css"; + +import "prismjs/components/prism-csharp.min"; + +import "prismjs/plugins/autolinker/prism-autolinker.min"; +import "prismjs/plugins/autolinker/prism-autolinker.css"; + +Vue.component("prism", Prism); \ No newline at end of file diff --git a/docs/static/README.md b/docs/static/README.md new file mode 100644 index 0000000..cf00435 --- /dev/null +++ b/docs/static/README.md @@ -0,0 +1,11 @@ +# STATIC + +**This directory is not required, you can delete it if you don't want to use it.** + +This directory contains your static files. +Each file inside this directory is mapped to `/`. +Thus you'd want to delete this README.md before deploying to production. + +Example: `/static/robots.txt` is mapped as `/robots.txt`. + +More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#static). diff --git a/docs/static/favicon.ico b/docs/static/favicon.ico new file mode 100644 index 0000000..3632d0c Binary files /dev/null and b/docs/static/favicon.ico differ diff --git a/docs/static/icon.png b/docs/static/icon.png new file mode 100644 index 0000000..e076dd8 Binary files /dev/null and b/docs/static/icon.png differ diff --git a/docs/static/sw.js b/docs/static/sw.js new file mode 100644 index 0000000..ea69899 --- /dev/null +++ b/docs/static/sw.js @@ -0,0 +1 @@ +// THIS FILE SHOULD NOT BE VERSION CONTROLLED diff --git a/docs/store/README.md b/docs/store/README.md new file mode 100644 index 0000000..1972d27 --- /dev/null +++ b/docs/store/README.md @@ -0,0 +1,10 @@ +# STORE + +**This directory is not required, you can delete it if you don't want to use it.** + +This directory contains your Vuex Store files. +Vuex Store option is implemented in the Nuxt.js framework. + +Creating a file in this directory automatically activates the option in the framework. + +More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/vuex-store). diff --git a/docs/store/topics.js b/docs/store/topics.js new file mode 100644 index 0000000..8bdbfbd --- /dev/null +++ b/docs/store/topics.js @@ -0,0 +1,134 @@ +export const state = () => ({ + list: [ + { + title: 'Hello World', + category: 'Examples', + description: 'Shows how to create a minimal .NET Core server using Feather HTTP' + }, + { + title: 'Cookies', + category: 'Examples', + description: 'Shows how to read and write cookies' + }, + { + title: 'Query Strings', + category: 'Examples', + description: 'Shows how to parse a query string into controller method parameters' + }, + { + title: 'HTML Form', + category: 'Examples', + description: 'How to receive data from an HTML form' + }, + { + title: 'Receive or Send files', + category: 'Examples', + description: 'Shows how to receive and send files' + }, + { + title: 'HTTP Headers', + category: 'Examples', + description: 'Shows how to read and write HTTP Headers within a controller method' + }, + { + title: 'Static Files', + category: 'Examples', + description: 'Shows how to serve static files' + }, + { + title: 'JSON Output', + category: 'Examples', + description: 'Shows how to convert C# objects to JSON in a controller method' + }, + { + title: 'Routing', + category: 'Examples', + description: 'Shows how to configure routing for API/MVC controllers' + }, + { + title: 'Logging', + category: 'Examples', + description: 'Shows how to set up logging in Feather HTTP' + }, + { + title: 'Change Ports', + category: 'Examples', + description: 'How to change the port of the webserver' + }, + { + title: 'TLS', + category: 'Examples', + description: 'Shows how to set up HTTPS in Feather HTTP' + }, + { + title: 'Exception Handling', + category: 'Examples', + description: 'Shows how to handle and display exceptions in development and production' + }, + { + title: 'ORMs', + category: 'Data', + description: 'How to use with Entity Framework Core, Dapper, or RepoDB' + }, + { + title: 'Redis', + category: 'Data', + description: 'How to set up Redis' + }, + { + title: 'Vue', + category: 'JavaScript Frameworks', + description: 'How to set up Vue.js' + }, + { + title: 'Angular', + category: 'JavaScript Frameworks', + description: 'How to set up Angular' + }, + { + title: 'Svelt', + category: 'JavaScript Frameworks', + description: 'How to set up Svelt' + }, + { + title: 'React', + category: 'JavaScript Frameworks', + description: 'How to set up React' + }, + { + title: 'Razor Pages', + category: 'Application Framework', + description: 'How to set up Razor Pages' + }, + { + title: 'MVC', + category: 'Application Framework', + description: 'How to set up MVC' + }, + { + title: 'Blazor Server Side', + category: 'Application Framework', + description: 'How to set up Blazor Server Side' + }, + { + title: 'Blazor', + category: 'Application Framework', + description: 'How to set up Blazor' + }, + { + title: 'SignalR', + category: 'Application Framework', + description: 'How to set up SignalR' + } + ] +}) + +export const actions = {} + +export const mutations = {} + +export const getters = { + list(state) { + return state.list; + } +} \ No newline at end of file diff --git a/docs/tailwind.config.js b/docs/tailwind.config.js new file mode 100644 index 0000000..ea932b4 --- /dev/null +++ b/docs/tailwind.config.js @@ -0,0 +1,20 @@ +/* +** TailwindCSS Configuration File +** +** Docs: https://tailwindcss.com/docs/configuration +** Default: https://github.com/tailwindcss/tailwindcss/blob/master/stubs/defaultConfig.stub.js +*/ +module.exports = { + theme: { + extend: { + maxHeight: { + none: '0' + }, + width: { + 68: '20rem' + } + } + }, + variants: {}, + plugins: [require('tailwindcss-transitions')()] +}