annotate key files and init siteConfig edits
diff --git a/website/core/Footer.js b/website/core/Footer.js
index c2b317c..1b04a81 100644
--- a/website/core/Footer.js
+++ b/website/core/Footer.js
@@ -1,8 +1,7 @@
/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+Footer: The website/core/Footer.js file
+is a React component that acts as the footer for the site
+generated by Docusaurus and should be customized by the user.
*/
const React = require('react');
diff --git a/website/pages/en/index.js b/website/pages/en/index.js
index 77d657a..50f119a 100644
--- a/website/pages/en/index.js
+++ b/website/pages/en/index.js
@@ -1,8 +1,6 @@
/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+Pages: The website/pages directory
+contains example top-level pages for the site.
*/
const React = require('react');
diff --git a/website/siteConfig.js b/website/siteConfig.js
index 44bdb3f..8be7888 100644
--- a/website/siteConfig.js
+++ b/website/siteConfig.js
@@ -1,13 +1,13 @@
/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+Configuration file: The website/siteConfig.js file
+is the main configuration file used by Docusaurus.
*/
// See https://docusaurus.io/docs/site-config for all the possible
// site configuration options.
+const repoUrl = 'https://github.com/apache/singa'
+
// List of projects/orgs using your project for the users page.
const users = [
{
@@ -21,41 +21,43 @@
];
const siteConfig = {
- title: 'Test Site', // Title for your website.
- tagline: 'A website for testing',
- url: 'https://your-docusaurus-test-site.com', // Your website URL
+ title: 'Apache SINGA', // Title for your website.
+ tagline: 'Distributed deep learning system',
+ url: 'https://singa.apache.org/', // Your website URL
baseUrl: '/', // Base URL for your project */
// For github.io type URLs, you would set the url and baseUrl like:
// url: 'https://facebook.github.io',
// baseUrl: '/test-site/',
// Used for publishing and more
- projectName: 'test-site',
- organizationName: 'facebook',
+ projectName: 'website-for-apache-singa',
+ organizationName: 'Apache-AND-DB-System-NUS',
// For top-level user or org sites, the organization is still the same.
// e.g., for the https://JoelMarcey.github.io site, it would be set like...
// organizationName: 'JoelMarcey'
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
- {doc: 'doc1', label: 'Docs'},
+ {doc: 'Documentation/installation', label: 'Docs'},
{doc: 'doc4', label: 'API'},
{page: 'help', label: 'Help'},
- {blog: true, label: 'Blog'},
+ {blog: true, label: 'News'},
+ {href: repoUrl, label: 'GitHub'},
+ //{search: true},
],
// If you have users set above, you add it here:
users,
/* path to images for header/footer */
- headerIcon: 'img/favicon.ico',
- footerIcon: 'img/favicon.ico',
+ headerIcon: 'img/singa-logo.png',
+ footerIcon: 'img/singa-logo-square.png',
favicon: 'img/favicon.ico',
/* Colors for website */
colors: {
- primaryColor: '#9a4218',
- secondaryColor: '#6b2e10',
+ primaryColor: "#1A2B34",
+ secondaryColor: "#808080" // 2nd layer of toolbar in smaller screen
},
/* Custom fonts for website */
@@ -73,7 +75,7 @@
*/
// This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
- copyright: `Copyright © ${new Date().getFullYear()} Your Name or Your Company Name`,
+ copyright: `Copyright © ${new Date().getFullYear()} Apache SINGA`,
highlight: {
// Highlight.js theme to use for syntax highlighting in code blocks.
diff --git a/website/static/img/favicon.ico b/website/static/img/favicon.ico
index be74abd..437d467 100644
--- a/website/static/img/favicon.ico
+++ b/website/static/img/favicon.ico
Binary files differ
diff --git a/website/static/img/singa-logo-square.png b/website/static/img/singa-logo-square.png
new file mode 100644
index 0000000..a440f27
--- /dev/null
+++ b/website/static/img/singa-logo-square.png
Binary files differ
diff --git a/website/static/img/singa-logo.png b/website/static/img/singa-logo.png
new file mode 100644
index 0000000..6edec3e
--- /dev/null
+++ b/website/static/img/singa-logo.png
Binary files differ
