Add DocFX documentation site
@@ -156,3 +156,7 @@ $RECYCLE.BIN/
|
||||
#################
|
||||
*.userprefs
|
||||
*.nugetreferenceswitcher
|
||||
|
||||
#docfx
|
||||
_site
|
||||
api
|
||||
|
||||
@@ -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`.
|
||||
@@ -0,0 +1,3 @@
|
||||
@echo off
|
||||
docfx metadata
|
||||
docfx build
|
||||
@@ -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,0 +1,4 @@
|
||||
- name: Building Perspex
|
||||
href: build.md
|
||||
- name: Contributing
|
||||
href: contributing.md
|
||||
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 6.9 KiB |
|
After Width: | Height: | Size: 226 KiB |
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
@@ -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 :) ):
|
||||
|
||||

|
||||
|
||||
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!
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## Inspection support
|
||||
|
||||

|
||||
@@ -0,0 +1,2 @@
|
||||
@echo off
|
||||
docfx serve _site
|
||||
@@ -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,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/
|
||||
@@ -1,8 +1,8 @@
|
||||
# Getting Started
|
||||
# Getting Started
|
||||
|
||||
## Windows
|
||||
|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||
|
After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 233 KiB After Width: | Height: | Size: 233 KiB |
@@ -0,0 +1,2 @@
|
||||
- name: Getting Started
|
||||
href: gettingstarted.md
|
||||
@@ -5,11 +5,11 @@
|
||||
|
||||
A multi-platform .NET UI framework. It can run on Windows, Linux, Mac OS X, iOS and Android.
|
||||
|
||||

|
||||

|
||||
|
||||
Desktop platforms:
|
||||
|
||||
<a href='https://www.youtube.com/watch?t=28&v=c_AB_XSILp0' target='_blank'><a/>
|
||||
<a href='https://www.youtube.com/watch?t=28&v=c_AB_XSILp0' target='_blank'><a/>
|
||||
|
||||
Mobile platforms:
|
||||
|
||||
@@ -43,19 +43,19 @@ framework.
|
||||
## Documentation
|
||||
|
||||
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
|
||||
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/.
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
## 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 ##
|
||||
|
||||
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.
|
||||
|
||||