Browse Source

refactored folder structure, added /plugins which is initially only used by #57

Hakim El Hattab 11 years ago
parent
commit
f57de200ec

+ 2 - 2
README.md

@@ -118,7 +118,7 @@ Once Node.js and the dependencies are installed, run the following command from
 
 By default, the slides will be served at [localhost:1947](http://localhost:1947).
 
-You can change the appearance of the speaker notes by editing the file at `lib/slidenotes/notes.html`.	
+You can change the appearance of the speaker notes by editing the file at `plugin/slidenotes/notes.html`.	
 
 ### Known Issues
 
@@ -159,7 +159,7 @@ You can change the appearance of the speaker notes by editing the file at `lib/s
 - API methods for adding or removing all event listeners
 - The 'slidechange' event now includes currentSlide and previousSlide
 - Fixed bug where 'slidechange' was firing twice when history was enabled
-- Changed /lib structure
+- Folder structure updates for scalability (see /lib & /plugin)
 - Slide notes by [rmurphey](https://github.com/rmurphey)
 
 #### 1.3

+ 1 - 1
css/main.css

@@ -12,7 +12,7 @@
 
 @font-face {
 	font-family: 'League Gothic';
-	src: url('../lib/leaguegothic/league_gothic-webfont.ttf') format('truetype');
+	src: url('../lib/font/league_gothic-webfont.ttf') format('truetype');
 	font-weight: normal;
 	font-style: normal;
 }

+ 4 - 4
index.html

@@ -18,7 +18,7 @@
 		<link rel="stylesheet" href="css/main.css">
 		<link rel="stylesheet" href="css/print.css" type="text/css" media="print">
 
-		<link rel="stylesheet" href="lib/highlight/zenburn.css">
+		<link rel="stylesheet" href="lib/css/zenburn.css">
 	</head>
 	
 	<body>
@@ -264,7 +264,7 @@ linkify( 'a' );
 		</div>
 
 		<!-- Optional libraries for code syntax highlighting and classList support in IE9 -->
-		<script src="lib/head/head.min.js"></script>
+		<script src="lib/js/head.min.js"></script>
 
 		<script>
 			// Load the main reveal.js script
@@ -314,14 +314,14 @@ linkify( 'a' );
 			} );
 			
 			// Load third party scripts
-			head.js( 'lib/highlight/highlight.js', 'lib/polyfills/classList.js', function() {
+			head.js( 'lib/js/highlight.js', 'lib/js/classList.js', function() {
 				// Fire off syntax highlighting for potential code samples in the slides
 				hljs.initHighlightingOnLoad();
 			} );
 
 			// If we're runnning the notes server we need to include some additional JS
 			if( window.location.host === 'localhost:1947' ) {
-				head.js( 'socket.io/socket.io.js', 'lib/slidenotes/client.js' );
+				head.js( 'socket.io/socket.io.js', 'plugin/slidenotes/client.js' );
 			}
 		</script>
 		

+ 0 - 0
lib/highlight/zenburn.css → lib/css/zenburn.css


+ 0 - 0
lib/leaguegothic/league_gothic-webfont.ttf → lib/font/league_gothic-webfont.ttf


+ 0 - 0
lib/leaguegothic/LICENSE → lib/font/league_gothic_license


+ 0 - 0
lib/polyfills/classList.js → lib/js/classList.js


+ 0 - 0
lib/head/head.min.js → lib/js/head.min.js


+ 0 - 0
lib/highlight/highlight.js → lib/js/highlight.js


+ 0 - 0
lib/slidenotes/client.js → plugin/slidenotes/client.js


+ 2 - 2
lib/slidenotes/index.js → plugin/slidenotes/index.js

@@ -21,7 +21,7 @@ io.sockets.on('connection', function(socket) {
 });
 
 app.configure(function() {
-	[ 'css', 'assets', 'js', 'lib' ].forEach(function(dir) {
+	[ 'css', 'js', 'plugin', 'lib' ].forEach(function(dir) {
 		app.use('/' + dir, staticDir(opts.baseDir + dir));
 	});
 });
@@ -32,7 +32,7 @@ app.get("/", function(req, res) {
 
 app.get("/notes/:socketId", function(req, res) {
 
-	fs.readFile(opts.baseDir + 'lib/slidenotes/notes.html', function(err, data) {
+	fs.readFile(opts.baseDir + 'plugin/slidenotes/notes.html', function(err, data) {
 		res.send(Mustache.to_html(data.toString(), {
 			socketId : req.params.socketId
 		}));

+ 0 - 0
lib/slidenotes/notes.html → plugin/slidenotes/notes.html