mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	Add auto generated docs
This commit is contained in:
		
							
								
								
									
										50
									
								
								docs/breakingChanges.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								docs/breakingChanges.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,50 @@
 | 
			
		||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs.
 | 
			
		||||
# Breaking changes
 | 
			
		||||
 | 
			
		||||
### Breaking changes from history version to latest version:
 | 
			
		||||
 | 
			
		||||
## #1
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
mermaid.initialize({
 | 
			
		||||
    sequenceDiagram:{
 | 
			
		||||
        ...
 | 
			
		||||
    }
 | 
			
		||||
})
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
has been changed to
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
mermaid.initialize({
 | 
			
		||||
    sequence:{
 | 
			
		||||
        ...
 | 
			
		||||
    }
 | 
			
		||||
})
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## #2
 | 
			
		||||
 | 
			
		||||
In old versions you needed to reference a CSS file in your HTML:
 | 
			
		||||
 | 
			
		||||
```html
 | 
			
		||||
<link rel="stylesheet" href="mermaid.min.css">
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
or
 | 
			
		||||
 | 
			
		||||
```html
 | 
			
		||||
<link rel="stylesheet" href="mermaid.forest.min.css">
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Now it is not needed, and there are no more CSS files in the distribution files.
 | 
			
		||||
 | 
			
		||||
You just:
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
mermaid.initialize({
 | 
			
		||||
    theme: 'forest'
 | 
			
		||||
})
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
and it works like a charm because now the CSS is inline with the SVG to allow simpler portability.
 | 
			
		||||
		Reference in New Issue
	
	Block a user