Browse Source

Add DocFX documentation site

pull/419/head
Wiesław Šoltés 11 years ago
parent
commit
83d122405a
  1. 4
      .gitignore
  2. 21
      docs/README.md
  3. 3
      docs/build.cmd
  4. 55
      docs/docfx.json
  5. 0
      docs/guidelines/build.md
  6. 0
      docs/guidelines/contributing.md
  7. 4
      docs/guidelines/toc.yml
  8. 0
      docs/images/add-dialogs.png
  9. BIN
      docs/images/cross-platform.png
  10. BIN
      docs/images/hello-world-xaml.png
  11. BIN
      docs/images/inspection-support.png
  12. 0
      docs/images/perspex-video.png
  13. 0
      docs/images/screen.png
  14. 37
      docs/index.md
  15. 2
      docs/serve.cmd
  16. 0
      docs/spec/architecture.md
  17. 0
      docs/spec/defining-properties.md
  18. 0
      docs/spec/styles.md
  19. 8
      docs/spec/toc.yml
  20. 0
      docs/spec/working-with-properties.md
  21. 10
      docs/toc.yml
  22. 6
      docs/tutorial/gettingstarted.md
  23. BIN
      docs/tutorial/images/add-dialogs.png
  24. 0
      docs/tutorial/images/add-packages.png
  25. 2
      docs/tutorial/toc.yml
  26. 12
      readme.md

4
.gitignore

@ -156,3 +156,7 @@ $RECYCLE.BIN/
################# #################
*.userprefs *.userprefs
*.nugetreferenceswitcher *.nugetreferenceswitcher
#docfx
_site
api

21
docs/README.md

@ -0,0 +1,21 @@
# Perspex Documentation
* [API Reference](http://perspex.github.io/)
## Building
Download and unzip `docfx.zip` into `Documentation` folder from [DocFX project site](https://github.com/dotnet/docfx/releases).
**Step 1.** To create `_site` documentation folder run build script
```
build.cmd
```
**Step 2.** To browse `_site` documentation folder run serve script
```
serve.cmd
```
And you can view the generated website in your browser `http://localhost:8080`.

3
docs/build.cmd

@ -0,0 +1,3 @@
@echo off
docfx metadata
docfx build

55
docs/docfx.json

@ -0,0 +1,55 @@
{
"metadata": [
{
"src": [
{
"files": [
"/src/Gtk/Perspex.Cairo/Perspex.Cairo.csproj",
"/src/Gtk/Perspex.Gtk/Perspex.Gtk.csproj",
"/src/Markup/Perspex.Markup/Perspex.Markup.csproj",
"/src/Markup/Perspex.Markup.Xaml/Perspex.Markup.Xaml.csproj",
"/src/Perspex.Animation/Perspex.Animation.csproj",
"/src/Perspex.Application/Perspex.Application.csproj",
"/src/Perspex.Base/Perspex.Base.csproj",
"/src/Perspex.Controls/Perspex.Controls.csproj",
"/src/Perspex.Diagnostics/Perspex.Diagnostics.csproj",
"/src/Perspex.HtmlRenderer/Perspex.HtmlRenderer.csproj",
"/src/Perspex.Input/Perspex.Input.csproj",
"/src/Perspex.Interactivity/Perspex.Interactivity.csproj",
"/src/Perspex.Layout/Perspex.Layout.csproj",
"/src/Perspex.ReactiveUI/Perspex.ReactiveUI.csproj",
"/src/Perspex.SceneGraph/Perspex.SceneGraph.csproj",
"/src/Perspex.Styling/Perspex.Styling.csproj",
"/src/Perspex.Themes.Default/Perspex.Themes.Default.csproj",
"/src/Skia/Perspex.Skia.Desktop/Perspex.Skia.Desktop.csproj",
"/src/Windows/Perspex.Designer/Perspex.Designer.csproj",
"/src/Windows/Perspex.Direct2D1/Perspex.Direct2D1.csproj",
"/src/Windows/Perspex.Win32/Perspex.Win32.csproj",
],
"exclude": [ "**/bin/**", "**/obj/**" ],
"cwd": ".."
}
],
"dest": "api"
},
],
"build": {
"content":
[
{
"files": ["**/*.yml", "index.md", "tutorial/*.md", "guidelines/*.md", "spec/*.md"],
}
],
"resource": [
{
"files": ["images/**", "tutorial/images/**", "guidelines/images/**", "spec/images/**"]
}
],
"overwrite": "apidoc/*.md",
"globalMetadata": {
"_appTitle": "Perspex Website"
},
"dest": "_site",
"template": "default"
}
}

0
docs/build.md → docs/guidelines/build.md

0
docs/contributing.md → docs/guidelines/contributing.md

4
docs/guidelines/toc.yml

@ -0,0 +1,4 @@
- name: Building Perspex
href: build.md
- name: Contributing
href: contributing.md

0
docs/add-dialogs.png → docs/images/add-dialogs.png

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/images/cross-platform.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

BIN
docs/images/hello-world-xaml.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

BIN
docs/images/inspection-support.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

0
docs/perspex-video.png → docs/images/perspex-video.png

Before

Width:  |  Height:  |  Size: 133 KiB

After

Width:  |  Height:  |  Size: 133 KiB

0
docs/screen.png → docs/images/screen.png

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 104 KiB

37
docs/index.md

@ -0,0 +1,37 @@
# The Perspex UI Framework
Cross platform .NET UI Framework with bindings and XAML
## Current status
We're pleased to announce that Perspex is now in alpha!
What does alpha mean? Well, it means that it's now at a stage where you can have a play and hopefully create simple applications. There's now a Visual Studio Extension containing project and item templates that will help you get started, and there's an initial complement of controls. There's still a lot missing, and you will find bugs, and the API will change, but this represents the first time where we've made it somewhat easy to have a play and experiment with the framework.
## How do I try it out
The easiest way to try out Perspex is to install the [Visual Studio Extension](https://visualstudiogallery.msdn.microsoft.com/a4542e8a-b56c-4295-8df1-7e220178b873).
This will add a Perspex project template and a Window template to the standard Visual Studo "Add" dialog (yes, icons still to come :) ):
![](images/add-dialogs.png)
Creating a Perspex Project will give you a simple project with a single XAML window. There's currently no designer, and not even any type-checking or intellisense for Perspex's xaml, but it works when you press F5, which is the important part!
![](images/hello-world-xaml.png)
You can also find the project [on GitHub](https://github.com/Perspex/Perspex/)
## News
You can read news about Perspex on [Groky's blog](http://grokys.github.io/)
## Cross Platform
Fow now we can run on Windows, Linux and Mac.
![](images/cross-platform.png)
## Inspection support
![](images/inspection-support.png)

2
docs/serve.cmd

@ -0,0 +1,2 @@
@echo off
docfx serve _site

0
docs/architecture.md → docs/spec/architecture.md

0
docs/defining-properties.md → docs/spec/defining-properties.md

0
docs/styles.md → docs/spec/styles.md

8
docs/spec/toc.yml

@ -0,0 +1,8 @@
- name: Perspex Architecture
href: architecture.md
- name: Styling in Perspex
href: styles.md
- name: Defining Properties
href: defining-properties.md
- name: Working with Properties
href: working-with-properties.md

0
docs/working-with-properties.md → docs/spec/working-with-properties.md

10
docs/toc.yml

@ -0,0 +1,10 @@
- name: Home
href: index.md
- name: Getting Started
href: tutorial/
- name: Guidelines
href: guidelines/
- name: Specifications
href: spec/
- name: API Documentation
href: api/

6
docs/gettingstarted.md → docs/tutorial/gettingstarted.md

@ -1,8 +1,8 @@
# Getting Started # Getting Started
## Windows ## Windows
![](add-dialogs.png) ![](images/add-dialogs.png)
The easiest way to try out Perspex is to install the Visual Studio Extension. The easiest way to try out Perspex is to install the Visual Studio Extension.
@ -12,4 +12,4 @@ This will add a Perspex project template and a Window template to the standard V
It is a little more manual on non-Windows platforms, but using Xamarin Studio you can install the Perspex NuGet package. It is a little more manual on non-Windows platforms, but using Xamarin Studio you can install the Perspex NuGet package.
![](add-packages.png) ![](images/add-packages.png)

BIN
docs/tutorial/images/add-dialogs.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

0
docs/add-packages.png → docs/tutorial/images/add-packages.png

Before

Width:  |  Height:  |  Size: 233 KiB

After

Width:  |  Height:  |  Size: 233 KiB

2
docs/tutorial/toc.yml

@ -0,0 +1,2 @@
- name: Getting Started
href: gettingstarted.md

12
readme.md

@ -5,11 +5,11 @@
A multi-platform .NET UI framework. It can run on Windows, Linux, Mac OS X, iOS and Android. A multi-platform .NET UI framework. It can run on Windows, Linux, Mac OS X, iOS and Android.
![](docs/screen.png) ![](docs/images/screen.png)
Desktop platforms: Desktop platforms:
<a href='https://www.youtube.com/watch?t=28&v=c_AB_XSILp0' target='_blank'>![](docs/perspex-video.png)<a/> <a href='https://www.youtube.com/watch?t=28&v=c_AB_XSILp0' target='_blank'>![](docs/images/perspex-video.png)<a/>
Mobile platforms: Mobile platforms:
@ -43,19 +43,19 @@ framework.
## Documentation ## Documentation
As mentioned above, Perspex is still in alpha and as such there's not much documentation yet. You can As mentioned above, Perspex is still in alpha and as such there's not much documentation yet. You can
take a look at the [getting started page](docs/gettingstarted.md) for an take a look at the [getting started page](docs/tutorial/gettingstarted.md) for an
overview of how to get started but probably the best thing to do for now is to already know a little bit overview of how to get started but probably the best thing to do for now is to already know a little bit
about WPF/Silverlight/UWP/XAML and ask questions in our [Gitter room](https://gitter.im/Perspex/Perspex). about WPF/Silverlight/UWP/XAML and ask questions in our [Gitter room](https://gitter.im/Perspex/Perspex).
There's also a high-level [architecture document](docs/architecture.md) that is currently a little bit There's also a high-level [architecture document](docs/spec/architecture.md) that is currently a little bit
out of date, and I've also started writing blog posts on Perspex at http://grokys.github.io/. out of date, and I've also started writing blog posts on Perspex at http://grokys.github.io/.
Contributions are always welcome! Contributions are always welcome!
## Building and Using ## Building and Using
See the [build instructions here](https://github.com/grokys/Perspex/blob/master/docs/build.md) See the [build instructions here](https://github.com/grokys/Perspex/blob/master/docs/guidelines/build.md)
## Contributing ## ## Contributing ##
Please read the [contribution guidelines](docs/contributing.md) before submitting a pull request. Please read the [contribution guidelines](docs/guidelines/contributing.md) before submitting a pull request.

Loading…
Cancel
Save