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..4278d29 --- /dev/null +++ b/docs/components/card.vue @@ -0,0 +1,26 @@ + +{{description}}
++ While this section will serve to show how to do something with Feather Http, we'll also be going over some of the core concepts necessary to understand what Feather Http is attempting to do and how it works. + We'll be breaking down these core concepts: +
But first, here is the code to get your project up, running and saying "Hello World!" You can add this to the program.cs
+Now you can run this by typing dotnet run. You can then navigate to http://localhost:5000 view the output.
+If you installed the template from getting started, then you already have this code.
+We recommend using VS Code in order to get a consistent experience with what we describe in these docs. + You can get VS Code by clicking the link. It will open to the VS Code download page in a new tab.
++ 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#.
+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.
+ +