Giter VIP home page Giter VIP logo

pixi-elementals's Introduction

Slate: API Documentation Generator
Build Status Docker Version

Slate helps you create beautiful, intelligent, responsive API documentation.

Screenshot of Example Documentation created with Slate

The example above was created with Slate. Check it out at slatedocs.github.io/slate.

Features

  • Clean, intuitive design — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripe's and PayPal's API docs. Slate is responsive, so it looks great on tablets, phones, and even in print.

  • Everything on a single page — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.

  • Slate is just Markdown — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks.

  • Write code samples in multiple languages — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with GitHub Flavored Markdown.

  • Out-of-the-box syntax highlighting for over 100 languages, no configuration required.

  • Automatic, smoothly scrolling table of contents on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.

  • Let your users update your documentation for you — By default, your Slate-generated documentation is hosted in a public GitHub repository. Not only does this mean you get free hosting for your docs with GitHub Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.

  • RTL Support Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc.

Getting started with Slate is super easy! Simply press the green "use this template" button above and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the sample docs.

Getting Started with Slate

To get started with Slate, please check out the Getting Started section in our wiki.

We support running Slate in three different ways:

Companies Using Slate

You can view more in the list on the wiki.

Questions? Need Help? Found a bug?

If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to start a thread in our Discussions tab!

Found a bug with upstream Slate? Go ahead and submit an issue. And, of course, feel free to submit pull requests with bug fixes or changes to the dev branch.

Contributors

Slate was built by Robert Lord while at TripIt. The project is now maintained by Matthew Peveler and Mike Ralphson.

Thanks to the following people who have submitted major pull requests:

Also, thanks to Sauce Labs for sponsoring the development of the responsive styles.

pixi-elementals's People

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

mathiasbockwoldt ar664 erenerturk1

pixi-elementals's Issues

Particle sample needs particle image

Particles session missing detail on getting image also

I'm loving the PixiJS tutorial - very informative.

The section on particles talks about going to the Particle Designer. It then mentions getting the json file but leaves out mentioning that you also need to grab the particle image as well - it's obvious to me now but not at the time ;)

(opinion alert) use arrow functions instead of `.bind`

I think it's a bit less confusing for beginners.

class A {
    private myName: string = "I am A";
    public method: Function;
}

class B {
    private myName: string = "I am B";

    public printName = () => {
        // Here... what does "this" means?!
        console.log(this.myName);
    }
}

const a = new A();
const b = new B();

a.method = b.printName;
a.method(); // This will print "I am B"
b.printName(); // This will print "I am B"

Pixi-particles issue

Bug Description
When I'm learning the particles in pixi elemental tutorial, I don't see anything show up on the screen in v7, meanwhile in v6 it's work normally

Screenshots
This is in pixi v6:
image

Code Following the example

import { Emitter } from "pixi-particles";
import { Application, ParticleContainer, Texture } from "pixi.js";
import * as particleSettings from "./emitter.json";

const app = new Application({
  view: document.getElementById("main") as HTMLCanvasElement,
  resolution: window.devicePixelRatio || 1,
  autoDensity: true,
  backgroundColor: 0x6495ed,
  width: 780,
  height: 600,
});

const particleContainer: ParticleContainer = new ParticleContainer();
app.stage.addChild(particleContainer);

const emitter = new Emitter(
  particleContainer,
  Texture.from("/images/particle.png"),
  particleSettings
);
emitter.autoUpdate = true;
emitter.updateSpawnPos(100, 100);
emitter.emit = true;

Compiler errors in Context step

Bug Description
tsconfig.json requires editing for Context step to not throw compiler errors.

I was just following the tutorial and got to the context step and received the following errors

ERROR in C:\dev\pixi\pixi-hotwire\src\index.ts
./src/index.ts 69:12-18
[tsl] ERROR in C:\dev\pixi\pixi-hotwire\src\index.ts(69,13)
TS6133: 'myName' is declared but its value is never read.

ERROR in C:\dev\pixi\pixi-hotwire\src\index.ts
./src/index.ts 70:11-17
[tsl] ERROR in C:\dev\pixi\pixi-hotwire\src\index.ts(70,12)
TS2564: Property 'method' has no initializer and is not definitely assigned in the constructor.

To get it to compile and return the expected console output I had to set
"strict" and "noUnusedLocals" to false in tsconfig.json.

Apologies if I missed a step.

AnimatedSprite expects array of TextureSource not String

Bug Description
In the AnimatedSprite section following the code results in the following error:

TS2345: Argument of type 'String' is not assignable to parameter of type 'TextureSource | TextureSource[]'.
Type 'String' is missing the following properties from type 'TextureSource[]': pop, push, join, reverse, and 21 more.

After importing the TextureSource class and making the array of type TextureSource instead of String it compiled as expected.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.