Skip to content

Commit

Permalink
moved to docsy
Browse files Browse the repository at this point in the history
  • Loading branch information
kkoreilly committed Jun 25, 2023
1 parent 7975f24 commit f0ede6d
Show file tree
Hide file tree
Showing 85 changed files with 3,488 additions and 292 deletions.
10 changes: 5 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
/public
resources/
node_modules/
package-lock.json
.hugo_build.lock
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
4 changes: 4 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM klakegg/hugo:ext-alpine

RUN apk add git && \
git config --global --add safe.directory /src
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2023, The GoKi Authors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
95 changes: 95 additions & 0 deletions assets/icons/logo.svg.temp
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->

<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="210mm"
height="297mm"
viewBox="0 0 744.09448819 1052.3622047"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="gogi_logo_blue.svg"
inkscape:export-filename="/Users/oreilly/goki/gi/logo/gogi_logo_blue.png"
inkscape:export-xdpi="300.55759"
inkscape:export-ydpi="300.55759">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="22.627417"
inkscape:cx="292.35329"
inkscape:cy="488.64701"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1">
<rect
style="opacity:1;fill:#ffffff;fill-opacity:0.50196081;fill-rule:nonzero;stroke:#ffffff;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect4177"
width="37.628181"
height="37.628181"
x="280.91077"
y="553.88354" />
<text
xml:space="preserve"
style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:49.23970032px;line-height:100%;font-family:Arial;-inkscape-font-specification:Arial;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;letter-spacing:0px;word-spacing:0px;text-transform:none;direction:ltr;block-progression:tb;writing-mode:lr-tb;text-anchor:start;display:inline;overflow:visible;visibility:visible;fill:#00addd;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker:none;enable-background:accumulate;"
x="270.22281"
y="606.47467"
id="text4136"
sodipodi:linespacing="100%"
transform="scale(1.0280475,0.97271767)"><tspan
style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Arial;-inkscape-font-specification:'Arial Bold Italic';fill:#00addd;fill-opacity:1;"
sodipodi:role="line"
id="tspan4138"
x="270.22281"
y="606.47467">G</tspan></text>
<text
xml:space="preserve"
style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:25.78528404px;line-height:100%;font-family:Arial;-inkscape-font-specification:Arial;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;letter-spacing:0px;word-spacing:0px;text-transform:none;direction:ltr;block-progression:tb;writing-mode:lr-tb;text-anchor:start;display:inline;overflow:visible;visibility:visible;fill:#00addd;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker:none;enable-background:accumulate;"
x="255.47765"
y="662.85553"
id="text4140"
sodipodi:linespacing="100%"
transform="scale(1.1381387,0.87862753)"><tspan
style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Arial;-inkscape-font-specification:'Arial Bold Italic';fill:#00addd;fill-opacity:1;"
sodipodi:role="line"
id="tspan4142"
x="255.47765"
y="662.85553">i</tspan></text>
<ellipse
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#ffffff;fill-rule:evenodd;stroke:#00addc;stroke-width:1.77619064;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate;fill-opacity:1"
id="path4157"
cx="573.42078"
cy="308.46521"
rx="2.8663414"
ry="3.1348033"
transform="matrix(0.83442435,0.5511225,-0.58438773,0.81147457,0,0)" />
</g>
</svg>
8 changes: 8 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*
Add styles or override variables from the theme here.
*/

$primary: #007d9c;
$secondary: #cca600;
50 changes: 0 additions & 50 deletions content/_index.md

This file was deleted.

67 changes: 67 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: GoKi
---

{{< blocks/cover title="Welcome to GoKi!" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/docs/">
Get Started <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<!-- <a class="btn btn-lg btn-primary me-3 mb-4" href="https://github.com/goki">
View on GitHub <i class="fab fa-github ms-2 "></i> -->
</a>
<p class="lead mt-5">A framework for trees (Ki in Japanese) in Go, including the GoGi 2D & 3D GUI framework.</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}
GoKi is an open-source project that provides a set of frameworks for constructing cross-platform GUIs and other useful tools in pure Go using full-strength tree structures. The name GoKi is derived from the word tree in Japanese (木), which is pronounced Ki (き).
{{% /blocks/lead %}}


{{% blocks/section color="dark" type="row" %}}
{{% blocks/feature icon="fa-wrench" title="Create Almost Anything" url="/docs" %}}
A large library of widgets and 3D support make it possible to create almost anything with ease.
{{% /blocks/feature %}}


{{% blocks/feature icon="fa-mobile-screen" title="Write Once, Run Everywhere" url="/docs" %}}
With a single Go codebase, you can write apps that run on MacOS, Windows, Linux, iOS, Android, and the Web.
{{% /blocks/feature %}}


{{% blocks/feature icon="fa-paintbrush" title="Customize and Extend" url="/docs" %}}
You can extensively style and customize existing widgets and create new ones.
{{% /blocks/feature %}}


{{% /blocks/section %}}


{{% blocks/section %}}
Applications Built With GoKi
{.h1 .text-center}
{{% /blocks/section %}}


{{% blocks/section type="row" %}}

{{% blocks/feature icon="fa-code" title="Gide" url="/gide" %}}
An IDE and IDE framework built using Gi, with standard editor features like syntax highlighting, completion, and version control built-in.
{{% /blocks/feature %}}

{{% blocks/feature icon="fa-draw-polygon" title="Grid" url="/grid" %}}
A Go SVG vector drawing program, built using Gi and based on Inkscape.
{{% /blocks/feature %}}

{{% blocks/feature icon="fa-image" title="GoPix" url="/gopix" %}}
A keyboard-navigable Go picture management app, built with Gi.
{{% /blocks/feature %}}

{{% /blocks/section %}}


{{% blocks/section %}}
See more examples [here](/docs/examples)
{.h2 .text-center}
{{% /blocks/section %}}
File renamed without changes
32 changes: 32 additions & 0 deletions content/en/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: About GoKi
linkTitle: About
menu: {main: {weight: 10}}
---

{{% blocks/cover title="About GoKi" image_anchor="bottom" height="auto" %}}

A framework for trees (Ki in Japanese) in Go, including the GoGi 2D & 3D GUI framework.
{.mt-5}

{{% /blocks/cover %}}

{{% blocks/lead %}}

GoKi is an open-source project that provides a set of frameworks for constructing cross-platform GUIs and other useful tools in pure Go using full-strength tree structures. The name GoKi is derived from the word tree in Japanese (木), which is pronounced Ki (き).

{{% /blocks/lead %}}

{{% blocks/section %}}

### The core package of GoKi is Ki, which provides trees using the `Ki` interface implemented by the `Node` struct. This supports arbitrarily directed structural trees and standard operations on them.
{.text-center}

{{% /blocks/section %}}

{{% blocks/section %}}

### Gi uses the Ki tree infrastructure to implement a scenegraph-based GUI framework in full native idiomatic Go, with minimal OS-specific backend interfaces based originally on the Shiny drivers, now using go-gl/glfw and vulkan-based vgpu, and supporting MacOS, Linux, and Windows.
{.text-center}

{{% /blocks/section %}}
8 changes: 8 additions & 0 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Blog
menu: {main: {weight: 30}}
---

This is the **blog** section. It has two categories: News and Releases.

Files in these directories will be listed in reverse chronological order.
4 changes: 4 additions & 0 deletions content/en/blog/news/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: News
weight: 20
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions content/en/blog/news/first-post/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
date: 2018-10-06
title: Easy documentation with Docsy
linkTitle: Announcing Docsy
description: >
The Docsy Hugo theme lets project maintainers and contributors focus on content,
not on reinventing a website infrastructure from scratch
author: Riona MacNamara ([@rionam](https://twitter.com/bepsays))
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: Riona MacNamara / CC-BY-CA"
---

**This is a typical blog post that includes images.**

The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author.

## Including images

Here's an image (`featured-sunset-get.png`) that includes a byline and a caption.

{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}

The front matter of this post specifies properties to be assigned to all image resources:

```
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: Riona MacNamara / CC-BY-CA"
```

To include the image in a page, specify its details like this:

```
{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}
```

The image will be rendered at the size and byline specified in the front matter.


Loading

0 comments on commit f0ede6d

Please sign in to comment.