Skip to content
This repository was archived by the owner on Nov 6, 2019. It is now read-only.

Reinstate docs infrastructure #255

Merged
merged 11 commits into from
May 4, 2017
Merged

Reinstate docs infrastructure #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ffae6e9
Attempt at typedoc build - all but widgets build
blink1073 May 4, 2017
2ef71a9
Build all the docs
blink1073 May 4, 2017
12ce515
Check in the docs
blink1073 May 4, 2017
d5b12f6
Check in the built docs
blink1073 May 4, 2017
5fa937d
Add docs templates
blink1073 May 4, 2017
feffba4
Remove checked in docs
blink1073 May 4, 2017
96169a5
Move to individual tdoptions files
blink1073 May 4, 2017
3a82de9
remove top level tdoptions file
blink1073 May 4, 2017
0ffaf53
Check in the docs
blink1073 May 4, 2017
23a1b85
Update note about status
blink1073 May 4, 2017
d92f49c
Remove checked in docs for now
blink1073 May 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
*.suo
*.user
.DS_Store
docs/api
lib
node_modules
build
86 changes: 86 additions & 0 deletions docs/about.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>PhosphorJS: About</title>
<meta name="description" content="PhosphorJS">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="apple-touch-icon" href="apple-touch-icon.png">
<link rel="icon" href="favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:400italic,300,300italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Nunito:300' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="css/normalize.min.css">
<link rel="stylesheet" href="css/main.css">

<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<script>window.html5 || document.write('<script src="js/vendor/html5shiv.js"><\/script>')</script>
<![endif]-->
</head>
<body>

<div class="header-container">
<header class="wrapper clearfix">
<a href="index.html">
<div class="logo"></div>
<h1 class="title">PhosphorJS</h1>
</a>
<nav>
<ul>
<li><a href="https://github.com/phosphorjs/phosphor">GitHub</a></li>
<li><a href="index.html">Docs</a></li>
<li><a href="about.html">About</a></li>
</ul>
</nav>
</header>
</div>

<div class="main-container">
<div class="main wrapper clearfix">
<article>
<h1>The PhosphorJS Project</h1>
<h2 id="what-">What?</h2>
<p>The PhosphorJS libraries cover topics including (but not limited to): message passing, signaling, attached properties, data structures, widgets, and layouts. Each of the libraries is a separately installable NPM package. Developers are free to use as much or as little of PhosphorJS as suits their needs.</p>
<p>Most users will be drawn to PhosphorJS for its high performance layouts and well structured widget hierarchy. These features allow a developer to build desktop-like experiences which are not possible using CSS alone, and which are not within the purview of most of today's web frameworks.</p>
<h2 id="why-">Why?</h2>
<p>HTML and CSS were designed for documents, not applications. There are certain classes of user interactions which are expected of production-quality desktop applications which are impossible to implement in CSS alone. Think of tabbed and docked panels in an IDE application. These types of interactions must be implemented using JavaScript, and implementing them in a scalable and elegant fashion requires a reasonable amount of architecture. This includes facilities such as: a message-passing hierarchy, resize/attach/detach/show/hide events, size constraint aggregation, and efficient layout computation. PhosphorJS provides these low-level facilities that are currently missing from the web, in a way which is flexible, unopinionated, and compatible with existing code.</p>
<h2 id="how-">How?</h2>
<ul>
<li>PhosphorJS provides a simple and flexible Widget class which establishes a hierarchy for message passing and DOM node manipulation. This enables the propagation of various messages throughout the hierarchy, such as: resize, attach, detach, show, and hide (among many others).
</li>
<li>Once establishing resize messages which propagate reliably, it becomes possible to implement layouts in JavaScript which would be impossible to achieve with CSS alone. By explicitly specifying the position and size of a node in absolute terms, the browser is able to optimize reflows so that they are contained within the affected portion of the page. This means that changes to one part of the application do not incur the cost of a reflow of the entire page.
</li>
<li>PhosphorJS recognizes that CSS is good at lots of things, and does not prevent the developer from using it when appropriate. PhosphorJS layouts play nicely with standard CSS layouts, and the two can be freely mixed within a widget hierarchy.
</li>
<li>PhosphorJS recognizes that developers have favorite frameworks that are well suited to a particular task. A Phosphor Widget instance can play host to DOM content generated by any other framework, and such a widget can be freely embedded within any Phosphor widget hierarchy.
</li>
<li>PhosphorJS provides a host of predefined widgets and layouts which are hard to implement correctly and efficiently, such as: menus and menu bars, split panels, and tabbed and docked panels. These make it simple to create the rich desktop-style applications described previously.
</li>
</ul>
<h2 id="can-i-use-it-now-">Can I use it now?</h2>
<p>Yes! All of the libraries listed on the <a href="docs.html">documentation page</a> have reached 1.0.</p>
</article>

<aside>
<div class="logo"></div>
<h2>PhosphorJS</h2>
<p>a collection of libraries <br>
designed to make it easy<br>
to build high-performance,<br>
pluggable, desktop-style <br>
web applications</p>
</aside>

</div> <!-- #main -->
</div> <!-- #main-container -->

<!-- <div class="footer-container">
<footer class="wrapper">
<h3>footer</h3>
</footer>
</div> -->

<script src="js/main.js"></script>
</body>
</html>
Loading