Retro/pcjs
Watch
1
0
Fork
You've already forked pcjs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

All references to GitHub project files should use the "master" branch

Browse source
This commit is contained in:
Jeff Parsons 2015-12-16 13:39:51 -08:00
commit ab4f24185c
6 changed files with 21 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

26
_posts/2015-12-10-rebuilding-the-pcjs-website.md
View file

@ -67,13 +67,14 @@ the following values, depending on whether you want an IBM PC or Challenger 1P,
- c1p
- c1p-dbg
and `id` can be any identifier you want to use to embed the machine. You may also use `config` to specify a machine XML
configuration file if not using the default `machine.xml`; `template` to specify an alternate XSL template file if not
using the default `components.xsl` file; `state` to specify a JSON-encoded machine state file if the machine requires a
predefined state; and `uncompiled` may be set to *true* to force a machine to use uncompiled sources, overriding the
and `id` can be any identifier you want to use to embed the machine. You may also use `config` to specify a machine
XML configuration file if not using the default `machine.xml`; `template` to specify an alternate XSL template file
if not using the default `components.xsl`; `state` to specify a JSON-encoded machine state file if the machine requires
a predefined state; and `uncompiled` may be set to *true* to force a machine to use uncompiled sources, overriding the
value of `site.pcjs.compiled` in **_config.yml**.
For example, the PCjs home page contains two machines, and so this appears at the top of the root [README.md](https://raw.githubusercontent.com/jeffpar/pcjs/gh-pages/README.md):
For example, the PCjs home page contains two machines, so this appears at the top of the root
[README.md](https://raw.githubusercontent.com/jeffpar/pcjs/master/README.md):
machines:
- type: pc
@ -85,14 +86,15 @@ For example, the PCjs home page contains two machines, and so this appears at th
I will continue to include a Node web server with the PCjs project, but it's now intended for development
purposes only (not production servers). I've updated the PCjs MarkOut component to parse any "Front Matter"
at the top of the PCjs Markdown files, and to convert all new Jekyll-style embedded machines to the old format,
so that pages generated by the Node web server will function more-or-less as before.
at the top of the PCjs Markdown files, and to convert all new Jekyll-style embedded machines and screenshots
to the older Markdown-compatible formats, so pages generated by the Node web server should still function
as before. But there are no guarantees.
A word of warning: if you decide to run/alternate between Jekyll's web server (WEBrick) and the built-in Node
web server (server.js), you should run "grunt clean" before starting either one, to clean up any old **index.html**
files; otherwise, Jekyll's server may pick up the wrong files. It's easy to tell when this happens, because
you'll see the wrong color scheme: the Node web server was designed to use *dark* colors, whereas the Jekyll web
server uses *light* colors.
WARNING: If you decide to run/alternate between Jekyll's web server (WEBrick) and the built-in Node web
server (server.js), you should run "grunt clean" before starting either one, to remove any old **index.html**
files; otherwise, Jekyll may inadvertently propagate those files to its "_site" folder. It's easy to tell
when this happens, because you'll see the wrong color scheme: Node web server pages were designed to use *dark*
colors, whereas Jekyll web server pages currently use *light* colors.
*[@jeffpar](http://twitter.com/jeffpar)*
*December 10, 2015*