Skip to content

Commit fd638b8

Browse files
author
Brylie Christopher Oxley
committed
Fix code block formatting and image links
1 parent ef4f717 commit fd638b8

2 files changed

Lines changed: 21 additions & 27 deletions

File tree

docs/advanced-customizations.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,11 @@ _As a prerequisite the CC Base Child Theme starter must be installed in the **wo
1515
- Open the wordpress directory in a text editor or IDE of your choice.
1616
- Navigate into the **wordpress**/**wp-content**/**themes**/**cc-wp-base-theme-starter**/**front** directory.
1717
- Install all the necessary node modules by running the command below in your terminal:
18-
19-
```
20-
npm install
21-
```
22-
18+
- `npm install`
2319
- To add custom styles cd into the styles folder, add your styles in the relevant sass files.
24-
- Run the npm scripts below in your terminal, to watch and compile your styles respectively.```
25-
npm watch
26-
27-
npm build
28-
```
20+
- Run the npm scripts below in your terminal, to watch and compile your styles respectively.
21+
- `npm watch`
22+
- `npm build`
2923

3024
## Advanced Widgets
3125

@@ -47,7 +41,7 @@ These are used to create containers. Column Containers are blocks of space that
4741
The Column Container Open widget is used to initialize a container component.
4842
Its parameters are shown in the screenshot below:
4943

50-
![Open column container widget parameters](/assets/content-images/advanced-widgets/open-column.png)
44+
![Open column container widget parameters](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/advanced-widgets/open-column.png)
5145

5246
- Remove Gap: This parameter denotes horizontal the space in between inner columns as well as the space below and above the container, in css those spaces are defined by grid gap, margin bottom, and margin top respectively. These all have a default value of 0.75rem.
5347
- Column Count: This parameter will allow you to set the number of columns in the container.
@@ -66,7 +60,7 @@ These widgets effectively form a single column structure which can be populated
6660
The Single Column Open widget is used to initialize a column component.
6761
Its parameters are shown in the screenshot below:
6862

69-
![Single column open container widget parameters](/assets/content-images/advanced-widgets/single-column-open.png)
63+
![Single column open container widget parameters](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/advanced-widgets/single-column-open.png)
7064

7165
- How many columns should be used: This parameter is used to configure the span of a single column. The parent container (refer to the previous section for more details) consists of a fixed number of columns which are set using the parameter Column Count. The How many columns should use field will allow you to set the number of columns the single column should occupy from the preset number columns.
7266
- Color: This parameter is used to set the background color of the single column.

docs/customizations.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Creative Commons Base Theme is highly flexible. Continue reading to learn ho
1313
- Go to **Customize** > **Site Identity**
1414
- In the field labeled **Site Title** enter a custom title of your site.
1515

16-
<![Emphasized title field and label](/assets/content-images/customizations/set-title.png)
16+
<![Emphasized title field and label](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-title.png)
1717

1818
## Custom site description or tag line
1919

@@ -22,7 +22,7 @@ The Creative Commons Base Theme is highly flexible. Continue reading to learn ho
2222
- Go to **Customize** > **Site Identity**
2323
- In the field labeled **Site Tagline** enter a custom tagline(or description) of your site.
2424

25-
![Emphasized tagline field and label](/assets/content-images/customizations/set-description.png)
25+
![Emphasized tagline field and label](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-description.png)
2626

2727
## Custom Icon
2828

@@ -32,19 +32,19 @@ The Creative Commons Base Theme is highly flexible. Continue reading to learn ho
3232
- Click the button labeled **Select Icon** to set up an icon.
3333
Note that the site icon must be a square that is 512 x 512 pixels.
3434

35-
![Emphasized icon field and label](/assets/content-images/customizations/set-icon.png)
35+
![Emphasized icon field and label](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-icon.png)
3636

3737
## Custom Navigation Menus
3838

3939
There are two menu locations in the site which are namely: Main Navigation and Footer Navigation.
4040

4141
The screenshot below shows an example of a custom menu in the Main Navigation:
4242

43-
![Main navigation](/assets/content-images/customizations/main-nav.png)
43+
![Main navigation](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/main-nav.png)
4444

4545
The screenshot below shows an example of a custom menu in the Footer Navigation:
4646

47-
![Footer navigation](/assets/content-images/customizations/footer-nav.png)
47+
![Footer navigation](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/footer-nav.png)
4848

4949
_The menus shown above are displayed in the desktop view. On any other screens, their appearance and or position might be different from what is shown above._
5050

@@ -56,15 +56,15 @@ _The menus shown above are displayed in the desktop view. On any other screens,
5656
- To proceed to the next step in the form, click the button labeled **Next**.
5757
- Then click the button labeled **+Add Items**, it will reveal all of the items which can be included in the menu.
5858

59-
![Form used to configure a custom menu on live preview](/assets/content-images/customizations/set-menu-live-preview.png)
59+
![Form used to configure a custom menu on live preview](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-menu-live-preview.png)
6060

6161
- Select menu items by clicking on them.
6262
- You are able to re-order the arrangement of selected menu items by dragging them up and down.
6363
- After you are done you may proceed to publish the changes.
6464

6565
### To create a custom menu using the dashboard:
6666

67-
![Form used to configure a custom menu on live preview](/assets/content-images/customizations/set-menu-dashboard.png)
67+
![Form used to configure a custom menu on live preview](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-menu-dashboard.png)
6868

6969
- Go to **Dashboard** > **Appearance** > **Menus**, the form in the diagram above will be shown.
7070
- Enter the menu name in the filled labeled **Menu Name**.
@@ -92,7 +92,7 @@ There are three layouts in the theme you can use to configure the structure of y
9292

9393
#### Default Layout
9494

95-
![Default page layout](/assets/content-images/customizations/default-page.png)
95+
![Default page layout](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/default-page.png)
9696

9797
This is the default layout of the page template, it has a default sidebar component on the left. To populate the sidebar with widgets:
9898

@@ -121,7 +121,7 @@ In order to display a static page on the homepage:
121121
- Create another page and give a title of your choice(e.g. Blog).
122122
- Go to **Dashboard** > **Settings** > **Reading**, and set your homepage display to the static page. Then set your Homepage to display the Homepage(the static page we created above) and set your posts to be displayed on the Blog page.
123123

124-
![Reading Settings](/assets/content-images/customizations/reading-settings.png)
124+
![Reading Settings](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/reading-settings.png)
125125

126126
- There are other optional settings outlined in the **Reading Settings** which you can use to also manage your site.
127127
- When done, click the button labeled **Save Changes**.
@@ -151,10 +151,10 @@ In order to display a static page on the homepage:
151151
- Select the Document tab
152152
- You will find Post Format listed in the Document settings.
153153
- Select your desired Post format from the dropdown:
154-
![Form to set post format](/assets/content-images/customizations/set-post-format.png)
154+
![Form to set post format](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-post-format.png)
155155
- Close the Settings by clicking on the gear icon.
156156
- On your editor at the very bottom of your post, click on the Post Format Panel so as to enlarge it.
157-
![Post format settings](/assets/content-images/customizations/post.png)
157+
![Post format settings](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/post.png)
158158
- Add relevant configuration details which will be influenced by the format you selected in the Settings.
159159

160160
### Post Formats
@@ -183,7 +183,7 @@ _If the above-listed post formats do not meet your requirements, you can complet
183183

184184
The widgets are available in **Dashboard** > **Appearance** > **Widgets**. On the left panel, we have the available widgets and the small panels on the right are the widget areas available in the theme.
185185

186-
![Available widgets](/assets/content-images/customizations/view-widgets.png)
186+
![Available widgets](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/view-widgets.png)
187187

188188
### To add a widget:
189189
- Drag it from the left panel into a widget area and provide the configuration information if it is required.
@@ -196,17 +196,17 @@ The widgets are available in **Dashboard** > **Appearance** > **Widgets**. On th
196196

197197
- Go to **Customize** > **Widgets**. If you are on a page that does not have any widget areas you will get a message shown in the screenshot below:
198198

199-
![No widgets listed on the live preview](/assets/content-images/customizations/no-widgets.png)
199+
![No widgets listed on the live preview](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/no-widgets.png)
200200

201201
When the page has widgets areas they are listed as shown in the screenshot below:
202202

203-
![Available widgets listed on the live preview](/assets/content-images/customizations/has-widgets.png)
203+
![Available widgets listed on the live preview](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/has-widgets.png)
204204

205205
- You select a widget area by clicking it.
206206
- To add widgets click the +Add Widget button and then select a widget from the widget panel on your right.
207207
- You are also able to search for widgets in the event the one you need is not displayed.
208208

209-
![Set widgets listed on the live preview](/assets/content-images/customizations/set-widgets.png)
209+
![Set widgets listed on the live preview](https://opensource.creativecommons.org/creativecommons-base/assets/content-images/customizations/set-widgets.png)
210210

211211
- After adding widgets you can then publish your changes.
212212

0 commit comments

Comments
 (0)